API 描述格式，例如 OpenAPI（原名為 Swagger 規格）、RAML 和 API Blueprint 改變了團隊對 API 文件的看法 — 提供了一種描述 API 行為和屬性的新方法。近年來，OpenAPI (OAS) 獲得了最廣泛的採用，並且迅速成為 REST API 定義的產業標準。隨著 OAS 的採用率不斷提高，新的工具也陸續出現，以協助釋放定義 API 的強大功能。
使用 OAS 和 Swagger 建置優質 API
Swagger 是使用 OAS 開發 API 時最廣泛使用的工具生態系統。雖然 Swagger 的名稱經常與規格互換使用 — Swagger 現在代表一個用於實作 OAS 的開源和專業工具集合。Swagger UI 是最廣為人知的 OAS API 文件工具之一。使用 Swagger UI — 無論是開源還是在 SwaggerHub 平台 內 — 您都可以將您的 OAS 合約轉換為互動式 API 主控台，消費者可以使用它與 API 互動，並快速了解 API 的行為方式。視覺化您所有的內部 API，讓開發人員可以快速輕鬆地使用上游和下游服務。SwaggerUI 內建互動性，因此外部消費者也可以試用 API 的每個資源，並在程式碼庫中使用它之前熟悉它。除了產生文件之外，Swagger 還支援使用 Swagger Codegen 為 API 產生實作程式碼和 SDK 的能力。它還可以協助您從 SwaggerHub 平台內將 API 定義部署到熱門的 API 閘道，例如 AWS、IBM API Connect、Apigee 和 Microsoft Azure。
開始使用 OAS 和 Swagger
雖然許多開發人員都很輕鬆地使用 OAS 從頭開始設計全新的 API，但為現有 API 產生 OAS 卻成為一項挑戰。反向工程規格不僅需要大量的工作，而且還需要學習曲線來熟悉從現有開發的 API 產生 OAS 的過程。Swagger 有多種工具可協助完成此流程，包括用於從 Java API 建立 OAS 的熱門 Swagger Core 專案，以及我們新推出的線上工具 Swagger Inspector，它可以自動從任何 API 端點產生 OAS 定義。在我們最新的白皮書中：記錄您的現有 API：使用 OpenAPI 和 Swagger 輕鬆建立 API 文件，我們介紹了 Swagger Inspector 並探討了開始使用 OAS 和 Swagger 的不同方法。我們涵蓋了
- API 文件的重要性
- 使用 OpenAPI 規格 (OAS) 建立 API 文件
- 建立 OAS 的方法
- 使用 Swagger 工具為現有 API 產生 OAS
- 在 SwaggerHub 中記錄您的 API
需要為現有的一組 API 產生 OpenAPI 定義嗎？試用 Swagger Inspector。想要標準化您的設計和文件流程嗎？立即開始使用 SwaggerHub。