API 文件

Swagger 提供一系列用於產生、視覺化和維護 API 文件的解決方案，免除 API 文件的人工工作。

在 SwaggerHub 中記錄 API

正在尋找開源 UI？ 下載 Swagger UI

從您的 API 設計產生文件

您的 API 功能的演變是不可避免的，但是維護 API 文件的麻煩不應該是這樣。Swagger 工具免除您產生和維護 API 文件的辛勞，確保您的文件隨著 API 的演進而保持最新狀態。

SwaggerHub 入口網站，用於 API 可見性

SwaggerHub，用於託管 API 文件

Swagger UI，用於視覺化 API

Documentation From Your API Design
記錄現有的 API

文件可以從 API 定義自動產生。但是如果您的現有 API 沒有定義呢？我們提供開源的 Swagger Core，從現有的 (Java) API 程式碼產生 OpenAPI 定義。如果您想加速此流程，您和您的團隊也可以嘗試使用 Swagger Inspector，為任何端點自動產生 OpenAPI 檔案。

Swagger Core，從現有的 (Java) API 程式碼產生 OpenAPI

Swagger Inspector，自動產生 OpenAPI 定義

Documenting Existing APIs

維護多個文件版本

您的 API 的內部和外部使用者應該可以輕鬆找到您 API 的所有可用版本，並取得如何使用的必要資訊。透過 SwaggerHub 的版本控制系統，在現有 API 文件的基礎上逐步建構，或維護多個 API 版本的相關文件。

探索 SwaggerHub 的文件版本控制功能

Maintain Multiple Documentation Versions

工具

可自訂的 API 開發人員入口網站

SwaggerHub 的最新功能 SwaggerHub 入口網站，讓您可以建立全面的面向消費者的文件，更容易發現您的 API 並加快其上線速度。

試用 SwaggerHub 入口網站

API 文件資源

文章 API 文件中的最佳實務 我們詳細介紹了一些優良實務，以協助您的團隊建立優質的 API 文件 電子書 記錄您現有的 API：使用 OpenAPI 和 Swagger 輕鬆製作 API 文件 API 描述格式 (如 OpenAPI (以前稱為 Swagger 規格)、RAML 和 API Blueprint) 改變了團隊的方式 ... 網路研討會 使用 OpenAPI 規格和 Swagger 工具的 API 文件 在此網路研討會中，我們將探討 OpenAPI 規格在記錄 API 中的作用 ...

自信地擴展您的 API 設計

設計

根據規格標準設計和建模 API

建構

以幾乎任何語言為您的 API 建構穩定、可重複使用的程式碼

文件

透過互動式 API 文件改善開發人員體驗

測試

在沒有額外負擔的情況下，對您的 API 執行簡單的功能測試

標準化

在您的 API 架構中設定和強制執行 API 樣式準則