swagger ui

介紹

Swagger UI允許任何人 - 無論是您的開發團隊還是您的最終消費者 - 都可以在沒有任何實施邏輯的情況下與API資源進行可視化和互動。它是由您的OpenAPI（以前稱為Swagger）規範生成的，其視覺文檔使後端實現和客戶端消耗變得易於使用。

一般的

？想要為簡單的開源貢獻獲得評分嗎？查看我們良好的第一期標籤。

？尋找較舊版本的Swagger UI？請參閱2.x分支。

該存儲庫發布了三個不同的NPM模塊：

• Swagger-UI是一個傳統的NPM模塊，旨在用於能夠解決依賴關係的單頁應用程序（通過WebPack，browserify等）。
• Swagger-UI-DIST是一個無依賴項的模塊，其中包括您在服務器端項目中提供Swagger UI的所有內容，或者無法解析NPM模塊依賴項的單頁應用程序。
• Swagger-UI反應被用作反應應用中的反應組件。

我們強烈建議您使用swagger-ui而不是swagger-ui-dist如果您要構建單頁應用程序，因為swagger-ui-dist大得多。

如果您正在尋找普通的OL'HTML/JS/CSS，請下載最新版本，然後將/dist文件夾的內容複製到服務器。

相容性

自2010年最初創建以來，OpenAPI規範已進行了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使用圍巾收集匿名安裝分析。這些分析有助於支持該庫的維護者，並且僅在安裝過程中運行。要選擇退出，您可以將scarfSettings.enabled已啟用字段設置為項目package.json中的false ：

 // package.json
{
  // ...
  "scarfSettings": {
    "enabled": false
  }
  // ...
}

另外，您可以將環境變量SCARF_ANALYTICS設置為false ，作為安裝NPM軟件包的環境的一部分，例如， SCARF_ANALYTICS=false npm install 。

文件

用法

• 安裝
• 配置
• 科爾斯
• OAuth2
• 深連接
• 限制
• 版本檢測

定制

• 概述
• 插件API
• 自定義佈局

發展

• 設定
• 腳本

貢獻

• 貢獻

集成測試

您將需要在此處指示的第7版或更高版本的JDK

集成測試可以使用npm run e2e在本地運行 - 確保在測試時不會運行Dev Server！

瀏覽器支持

Swagger UI在Chrome，Safari，Firefox和Edge的最新版本中工作。

已知問題

為了幫助遷移，以下是3.x的當前已知問題。此列表將定期更新，並且不會包含以前版本中未實現的功能。

• 以前僅支持的參數的一部分可用。
• JSON表單編輯器未實施。
• 支持collectionFormat是部分的。
• L10N（翻譯）未實施。
• 未實現對外部文件的相對路徑支持。

安全聯繫

請通過電子郵件[email protected]來披露與安全有關的問題或漏洞，而不是使用公共問題跟踪器。

執照

Swaggerui已獲得Apache 2.0許可證的許可。 Swaggerui帶有一個明確的通知文件，其中包含其他法律通知和信息。