api-doc-generator

API Doc Generator 是一款專為開發者與軟體工程師設計的專業 AI 技能，旨在簡化 API 技術文件的編寫流程。透過直接分析原始碼，此工具能精確識別 API 模式、參數、資料結構與認證機制，並將其轉換為結構化且易於閱讀的文件。它對於使用 FastAPI、Express 或任何公開 API 端點的開發框架特別有效，能協助團隊在無需手動維護的情況下，確保規格文件的即時更新。

• 自動解析程式碼庫，提取端點路徑、HTTP 方法及請求與響應結構。
• 支援多種 API 風格，包括 REST、GraphQL 及基於 RPC 的介面。
• 支援多種輸出格式：適合內部文件的 Markdown、用於生態系相容的 OpenAPI 3.0 (Swagger) 及 API Blueprint。
• 具備標準化模板系統，確保不同專案間文件風格的一致性。
• 識別關鍵 API 元數據，如 OAuth、JWT 及 API Key 認證架構。

此技能適用於需要於開發週期中生成文件的後端工程師、DevOps 工程師與技術寫作者。使用時，只需提供包含 API 端點的原始碼，AI 即會分析程式邏輯、推斷型別與參數，並輸出清晰格式化的結果。建議程式碼中包含 Docstrings 或型別提示，以提升生成文件的精確度與深度。輸出的文件針對可讀性進行了優化，提供包含路徑、查詢與請求體參數的清晰表格，以及範例請求與響應。這是自動化 API 規格管理、輔助 CI/CD 流程或日常開發工作的強大工具。