swagger ui
v5.18.2 Released!
Swagger UIは、開発チームであれ最終消費者であれ、誰でも、実装ロジックを整備せずにAPIのリソースを視覚化および対話することができます。 Openapi（以前はSwaggerとして知られていた）仕様から自動的に生成され、視覚的なドキュメントにより、バックエンドの実装とクライアントサイドの消費が簡単になります。
？簡単なオープンソースの貢献を獲得したいですか？ Good First Issueラベルをご覧ください。
？§swaggerUIの古いバージョンをお探しですか？ 2.xブランチを参照してください。
このリポジトリは、3つの異なるNPMモジュールを公開しています。
swagger-ui-distが大幅に大きいため、単一ページのアプリケーションを構築する場合は、 swagger-ui-distの代わりにswagger-uiを使用することを強くお勧めします。
プレーンオルHTML/JS/CSSを探している場合は、最新リリースをダウンロードして、 /distフォルダーのコンテンツをサーバーにコピーします。
Openapi仕様は、2010年の最初の作成以来5回の改訂版でした。SwaggerUIとOpenapi仕様の間の互換性は次のとおりです。
| Swagger UIバージョン | 発売日 | Openapiスペックの互換性 | メモ |
|---|---|---|---|
| 5.0.0 | 2023-06-12 | 2.0、3.0.0、3.0.1、3.0.2、3.0.3、3.1.0 | タグV5.0.0 |
| 4.0.0 | 2021-11-03 | 2.0、3.0.0、3.0.1、3.0.2、3.0.3 | タグV4.0.0 |
| 3.18.3 | 2018-08-03 | 2.0、3.0.0、3.0.1、3.0.2、3.0.3 | タグV3.18.3 |
| 3.0.21 | 2017-07-26 | 2.0 | タグv3.0.21 |
| 2.2.10 | 2017-01-04 | 1.1、1.2、2.0 | タグV2.2.10 |
| 2.1.5 | 2016-07-20 | 1.1、1.2、2.0 | タグV2.1.5 |
| 2.0.24 | 2014-09-12 | 1.1、1.2 | タグV2.0.24 |
| 1.0.13 | 2013-03-08 | 1.1、1.2 | タグV1.0.13 |
| 1.0.1 | 2011-10-11 | 1.0、1.1 | タグV1.0.1 |
SwaggeruiはScarfを使用して、匿名化されたインストール分析を収集します。これらの分析は、このライブラリのメンテナーをサポートし、インストール中にのみ実行されます。オプトアウトするには、 scarfSettings.enabledフィールドをプロジェクトのpackage.jsonでfalseに設定できます。
// package.json
{
// ...
"scarfSettings": {
"enabled": false
}
// ...
}
または、NPMパッケージをSCARF_ANALYTICS=false npm installする環境の一部として、環境変数SCARF_ANALYTICS falseに設定することができます。
ここで指示されているバージョン7以下のJDKが必要ですhttps://nightwatchjs.org/guide/getting-started/installation.html#install-selenium-server
統合テストはnpm run e2eでローカルに実行できます。テスト時に開発サーバーを実行していないことを確認してください！
Swagger UIは、Chrome、Safari、Firefox、およびEdgeの最新バージョンで動作します。
移行を支援するために、ここに3.xの現在知られている問題があります。このリストは定期的に更新され、以前のバージョンに実装されていない機能は含まれません。
collectionFormatのサポートは部分的です。Public Issue Trackerを使用する代わりに、[email protected]に電子メールを送信して、セキュリティ関連の問題や脆弱性を開示してください。
Swaggeruiは、Apache 2.0ライセンスに基づいてライセンスされています。 Swaggeruiには、追加の法的通知と情報を含む明示的な通知ファイルが付属しています。
