什麼是 Swagger

Swagger 可讓您描述 API 的結構，以便機器可以讀取它們。API 能夠描述自身結構的能力是 Swagger 中所有優點的根源。它為何如此出色？嗯，透過讀取您的 API 結構，我們可以自動建構美觀且互動式的 API 文件。我們也可以自動為您的 API 以多種語言產生用戶端程式庫，並探索其他可能性，例如自動化測試。Swagger 透過要求您的 API 傳回包含您整個 API 詳細描述的 YAML 或 JSON 來做到這一點。此檔案基本上是您的 API 的資源清單，符合OpenAPI 規格。規格要求您包含以下資訊，例如

您的 API 支援哪些所有操作？
您的 API 的參數是什麼，它會傳回什麼？
您的 API 是否需要一些授權？
甚至是條款、聯絡資訊和使用 API 的授權等有趣的事項。

您可以手動為您的 API 撰寫 Swagger 規格，或從原始碼中的註解自動產生。請查看swagger.io/open-source-integrations以取得可讓您從程式碼產生 Swagger 的工具清單。

所以，我有一個 API 的 Swagger 規格。接下來呢？

Swagger 可以透過幾種方式進一步推動您的 API 開發

設計優先的使用者：使用Swagger Codegen為您的 API產生伺服器存根。剩下的就是實作伺服器邏輯 – 您的 API 就可以上線了！
使用Swagger Codegen以 40 多種語言為您的 API產生用戶端程式庫。
使用Swagger UI產生互動式 API 文件，讓您的使用者可以直接在瀏覽器中嘗試 API 呼叫。
使用規格將與 API 相關的工具連接到您的 API。例如，將規格匯入SoapUI以建立 API 的自動化測試。
還有更多！請查看與 Swagger 整合的開源和商業工具。