OSS探訪

Swagger UI — OpenAPI定義を閲覧・実行できるAPIドキュメントへ変換する

スコアの見方

OSS規模スコアはStars・Watchers・Forks・Contributorsを対数圧縮して重み付けした現在の規模指標(上限なし)です。発掘スコアは現在のOSS規模スコアから発掘時点のOSS規模スコアを引いた値、更新ペースは直近30日Commit数、成長モメンタムは直近の観測期間におけるOSS規模スコア差、OSS健全度は取得できた更新状況・Community Health・Releaseの0〜100評価です。

Stars
29,013
主要言語
JavaScript
ライセンス
Apache-2.0
リポジトリ最終更新
2026/09/21

概要

Swagger UIは、OpenAPI SpecificationからAPI endpoint、parameter、schema等を可視化し、ブラウザからrequestを試せる対話型ドキュメントを生成します。npm module、React component、static assets、Docker imageから導入方法を選べます。

特徴と向いている用途

公式資料に基づく紹介・実機未検証 · 内容確認日:

OpenAPI定義から対話型ドキュメントを生成する

API定義を読み込み、endpointやschemaを画面化し、許可されたoperationではブラウザからrequestを試せます。

出典:[2][3]

npm・React・static assets・Dockerから配布方法を選ぶ

SPA向けmodule、React component、server側配信用dist、Docker imageを用途に応じて使い分けられます。

出典:[2][3]

OpenAPIをAPI利用者向けdocumentationとして公開する場合に

backend実装とclient利用者の間でOpenAPIを共通契約にし、閲覧・試行できるdocumentationを提供したい場合に向きます。

出典:[2]

公開範囲・CORS・OAuth・analytics設定を確認する

Try it outを有効にする場合はCORSや認証設定が必要です。公開してよいendpoint/schemaの範囲とScarf analyticsの扱いも確認してください。

出典:[2][3]

参考にした公式資料

  1. [1]swagger-api/swagger-ui repository(2026-09-21)
  2. [2]Swagger UI README(2026-09-21)
  3. [3]Swagger UI installation guide(2026-09-21)
  4. [4]swagger-ui package(2026-09-21)
  5. [5]Swagger UI Apache-2.0 license(2026-09-21)
編集部からの補足

現在のSwagger UIは5.33.0でOpenAPI 3.2.0まで対応表に記載されています。`swagger-ui`、`swagger-ui-dist`、`swagger-ui-react`の3配布形態があり、SPAでは通常`swagger-ui`が推奨です。npm install時にはScarfによる匿名analyticsがあり、必要ならopt-outできます。

3ステップで試す

  1. 1

    公式Docker imageを取得

    公式installation guideのpre-built imageを利用します。

    docker pull docker.swagger.io/swaggerapi/swagger-ui
  2. 2

    Petstore OpenAPI定義で起動

    外部OpenAPI URLを指定してSwagger UIをlocalで起動します。

    docker run --rm -p 80:8080 -e SWAGGER_JSON_URL=https://petstore3.swagger.io/api/v3/openapi.json docker.swagger.io/swaggerapi/swagger-ui
  3. 3

    ブラウザで確認

    endpoint一覧・schema・Try it outを確認し、自分のOpenAPI定義へ差し替える前に基本動作を試します。

    http://localhost/
公式READMEで確認

成長

成長の推移 · 直近30日

29,013 Stars

推移データを蓄積中です。

開発アクティビティ

直近90日・週次

Commit(直近30日)
27
Open PR
166

開発アクティビティを蓄積中です。

Built with

カテゴリとタグ

カテゴリ

GitHubデータ

GitHubのデータGitHubの詳細データを見る

GitHub Topics

  • swagger
  • swagger-ui
  • swagger-api
  • rest
  • rest-api
  • openapi-specification
  • oas
  • openapi
  • openapi3
  • hacktoberfest
  • openapi31
  • open-source
Stars
29,013
Forks
9,257
Watchers
623
Open Issues
963
Contributors
390
主要言語
JavaScript
ライセンス
Apache-2.0
リポジトリ最終更新
2026/09/21

このOSSの使い方や活用事例をMarkdownで投稿できます。管理者が承認した後に公開されます。

情報の誤りを報告

掲載内容に誤りや古い情報があればお知らせください。