api-documentation-generator

此 API 文件產生器是專為軟體工程師與技術撰稿人所設計的專業技能，旨在維護即時、機器可讀且符合人類閱讀習慣的 API 參考文件。透過分析您的程式碼庫，此代理程式能自動處理編寫端點說明、參數定義與回應架構的繁瑣工作，確保整個專案的文件一致性。對於採用 API 優先開發流程的團隊，或是需要整合後端實作與前端應用的開發者而言，這是一項不可或缺的工具。

• 從控制器程式碼、路由與模型定義中自動產生 OpenAPI 與 Swagger 2.0/3.0 規格。

• 建立包含路徑參數、查詢字串、標頭與請求主體的標準化端點文件。

• 提供結構化的回應範例，包含成功 (200 OK) 輸出及常見錯誤場景 (404, 401, 500 等)。

• 產生適用於多種程式語言的 SDK 使用範例，包括 cURL、JavaScript (Fetch) 與 Python (Requests)。

• 根據應用程式中定義的安全性協定，產出完整的整合與驗證指南。

• 協助建立錯誤代碼參考表與狀態碼說明。

• 輸入需求：當提供原始碼儲存庫、控制器檔案或特定路由定義作為上下文時，此技能的效果最佳。

• 整合建議：特別是在修改後端邏輯後，透過互動式工作階段中的斜線指令呼叫，能發揮極高效率。

• 最佳實踐：在 PR 審查期間使用此工具，確保文件能與功能開發同步。產出的內容遵循嚴格的 Markdown 結構，可直接嵌入維基、README 檔案或專用的文件入口網站。

• 限制：文件產出的精確度取決於程式碼本身的清晰度。建議配合描述性的 JSDoc 或 Python Docstrings 使用，以最大化端點說明的品質。