Repolode
投稿する
swagger-api

swagger-api/swagger-ui

Swagger UIはOpenAPI仕様ファイルから、ブラウザー上で操作できるAPIドキュメントを生成します。

代替できる製品:PostmanReadMe

GitHub で見る公式サイト
スター
29,040
フォーク
9,250
未解決の Issue
1,144
最終コミット
一昨日

これは何？

Swagger UIは、OpenAPI（旧Swagger）仕様を閲覧・操作できるドキュメントページとして表示する、HTML、JavaScript、CSSアセットのセットです。開発者やAPI利用者は、すべてのエンドポイント、そのパラメーターやレスポンスの形式を確認でき、クライアントコードを先に書かなくても、ページから直接テストリクエストを送信できます。

このプロジェクトは3つの形式で提供されています。バンドラーを使うシングルページアプリ向けのswagger-ui npmモジュール、npm依存関係を解決できないサーバーやアプリ向けの依存関係を含まないバンドルswagger-ui-dist、そしてReactコンポーネントのswagger-ui-reactです。distフォルダー内のHTML、JS、CSSファイルを任意のWebサーバーにコピーして使うこともできます。

現行リリースはOpenAPI 2.0から3.2.0までと、複数の3.xマイナーバージョンに対応しています。Chrome、Safari、Firefox、Edgeの最新バージョンで動作します。

主な機能

  • 01OpenAPIおよびSwagger仕様を、操作可能なドキュメントページとして表示します。
  • 02ブラウザーからエンドポイントに直接テストリクエストを送信できます。
  • 03npmモジュール、依存関係を含まないdistバンドル、Reactコンポーネントとして提供されています。
  • 04OAuth2認証と、特定の操作へのディープリンクに対応しています。
  • 05設定、プラグインAPI、カスタムレイアウトによるカスタマイズが可能です。

ユースケース

  • バックエンドサービスのAPIリファレンスを、社内または社外の利用者向けに公開する。
  • クライアントコードを書く前に、フロントエンドやモバイルのチームがAPIを確認できるようにする。
  • Reactアプリケーション内に、操作可能なAPIドキュメントを組み込む。
  • npm依存関係をインストールできないサーバーから、静的なAPIドキュメントを配信する。

トピック

#openapi#swagger#api-documentation#rest-api#javascript#api-testing#hacktoberfest#oas#open-source#openapi-specification

よくある質問

swagger-ui とは？
Swagger UIはOpenAPI仕様ファイルから、ブラウザー上で操作できるAPIドキュメントを生成します。 Swagger UIは、OpenAPI（旧Swagger）仕様を閲覧・操作できるドキュメントページとして表示する、HTML、JavaScript、CSSアセットのセットです。開発者やAPI利用者は、すべてのエンドポイント、そのパラメーターやレスポンスの形式を確認でき、クライアントコードを先に書かなくても、ページから直接テストリクエストを送信できます。
swagger-ui は無料で使えますか？ライセンスは？
swagger-ui は Apache-2.0 ライセンスのオープンソースです。商用製品で使う前にライセンス条件を確認してください。
swagger-ui は今もメンテナンスされていますか？
活発にメンテナンス中。swagger-ui の最終コミットは 2026年10月16日 です。
swagger-ui は何に使えますか？
バックエンドサービスのAPIリファレンスを、社内または社外の利用者向けに公開する。 クライアントコードを書く前に、フロントエンドやモバイルのチームがAPIを確認できるようにする。 Reactアプリケーション内に、操作可能なAPIドキュメントを組み込む。 npm依存関係をインストールできないサーバーから、静的なAPIドキュメントを配信する。
swagger-ui はどこで入手できますか？
ソースコードとインストール手順は GitHub にあります：https://github.com/swagger-api/swagger-ui

概要はプロジェクトの README をもとに AI が生成しています。GitHub の数値は毎日更新されます。

関連プロジェクト