API 文件是成功使用和整合 API 所需的資訊。這可以是技術寫作、程式碼範例和範例的形式，以便更好地理解如何使用 API。簡潔明瞭的文件 — 可讓您的 API 使用者快速將其導入應用程式中 — 對於希望推動 API 採用的組織而言，不再是可有可無的選項。
Swagger 如何協助 API 文件
Swagger 定義了 API 的 RESTful 協定，讓所有 API 的利害關係人，無論是您的開發團隊還是最終使用者，都能理解 API 的用途並與其各種資源互動，而無需將其整合到自己的應用程式中。Swagger 有助於定義一種與語言無關、人類可讀的 API 格式，簡化實作、推動採用並穩定開發。自創建以來，Swagger 已成為世界上最受歡迎的 API 開發框架，每月有超過一百萬次下載開放原始碼 Swagger 工具，並且已發展成為設計和記錄 RESTful API 的行業標準。
將 Swagger 新增至您的 API
開發團隊有多種方法可將 Swagger 新增至其 API。由於 Swagger 受到廣泛的開發者社群支援，因此這些方法中的每一種也都受到許多開放原始碼和商業工具的支援。在這本免費電子書下載中，我們將探討兩種最常用的方法：執行期間的 Swagger 產生 和 建置期間的 Swagger 產生，並介紹一些可支援這些方法的工具。您可以點擊下面的連結以下載 PDF 格式的電子書。下載：使用 Swagger 記錄現有 API 您也可以翻閱頁面底部的 SlideShare 簡報來閱讀電子書。
想要更多類似的資源嗎？
我們每月會發送幾次電子郵件，其中包含我們最新的 API 資源。請使用右側的註冊表格加入！