撰寫 API 文件的工具

發表於： 2021-07-20 分類於：學習

字數： 184 閱讀：≈ 1分鐘瀏覽：

Slate

將 Markdown 內容產生為靜態 API 文件網站，適合需要自訂版面與範例程式碼的專案。

從原始碼註解產生 API 文件，適合希望讓文件靠近實作程式碼的團隊。

以 OpenAPI 規格描述 API，可產生互動式文件，也方便驗證請求與回應格式。建立新專案時，建議直接維護 OpenAPI 規格，避免文件與實作脫節。