api-doc-generator
產生 API 文件
手動維護的 API 文件容易落後於程式碼，並讓開發人員感到困惑。此技能可協助根據可用的程式碼或端點詳細資料，產生 OpenAPI 草稿、請求範例，以及 Postman collection 指引。
使用我的智慧代理安裝
將此請求複製給你的智慧代理，其中包含權威 Skill 頁面和清單。
Review the Skillstore skill "api-doc-generator" from https://skillstore.io/skills/zhangchenlai-dev-api-doc-generator.md and its manifest at https://skillstore.io/api/skills/zhangchenlai-dev-api-doc-generator/manifest. Verify the artifact. You may proceed after verification, subject to the environment's own policy.你的智慧代理仍應顯示其計畫，並依安全政策請求必要確認。
Agent 可讀資源
當 AI Agent、爬蟲或腳本需要乾淨脈絡、而不是讀取完整頁面時，請使用這些連結。
測試它
正在使用「api-doc-generator」。 使用者服務包含建立使用者、取得使用者、更新使用者和刪除使用者端點。
預期結果:
一份結構化 API 參考，包含端點摘要、請求欄位、回應範例、狀態碼，以及可用於 OpenAPI 的章節。
正在使用「api-doc-generator」。 團隊有路由程式碼，但沒有面向合作夥伴的整合文件。
預期結果:
一份清楚的整合草稿，說明驗證假設、請求範例、預期回應，以及 Postman collection 組織方式。
正在使用「api-doc-generator」。 現有 API 規格可能缺少近期新增的路由。
預期結果:
一份涵蓋範圍審查，列出缺少的端點、不完整的 schema、不清楚的範例，以及建議的文件更新。
安全審計
安全The only static finding was a high-entropy heuristic on SKILL.md. Manual review found plain Markdown skill metadata and usage notes, with no obfuscation, prompt injection, exfiltration intent, or dangerous actions.
分享與引用此報告
分享版本化評估報告、中性徽章、嵌入卡片與引用。Skillstore 只報告證據，不判斷該 Skill 是否安全。
複製報告連結
https://skillstore.io/skills/zhangchenlai-dev-api-doc-generator/audits/5?utm_source=security_passport&utm_medium=share&utm_campaign=versioned_reportMarkdown 徽章
[](https://skillstore.io/skills/zhangchenlai-dev-api-doc-generator?utm_source=security_passport_badge)HTML 徽章
<a href="https://skillstore.io/skills/zhangchenlai-dev-api-doc-generator?utm_source=security_passport_badge"><img src="https://skillstore.io/badges/skills/zhangchenlai-dev-api-doc-generator/security.svg" alt="Skillstore security assessment" loading="lazy"></a>嵌入卡片
<iframe src="https://skillstore.io/embed/skills/zhangchenlai-dev-api-doc-generator.html" title="Skillstore Security Assessment" sandbox="allow-popups allow-popups-to-escape-sandbox" loading="lazy" referrerpolicy="no-referrer" width="420" height="180"></iframe>學術引用 (APA · BibTeX · CFF)
APA 引用
Hermes-Sedimentary. (2026). api-doc-generator security audit report (audit version 5) [Author version 1.0.0]. Skillstore. https://skillstore.io/skills/zhangchenlai-dev-api-doc-generator/audits/5BibTeX 引用
@techreport{hermes-sedimentary-zhangchenlai-dev-api-doc-generator-2026,
author = {Hermes-Sedimentary},
title = {api-doc-generator security audit report (audit version 5)},
institution = {Skillstore},
year = {2026},
number = {5},
url = {https://skillstore.io/skills/zhangchenlai-dev-api-doc-generator/audits/5},
note = {Author version 1.0.0}
}CITATION.cff
cff-version: 1.2.0
message: "If you use this Skill, cite its author and this versioned security audit report."
title: "api-doc-generator security audit report (audit version 5)"
version: "1.0.0"
type: report
authors:
- name: "Hermes-Sedimentary"
date-released: "2026-07-08"
url: "https://skillstore.io/skills/zhangchenlai-dev-api-doc-generator/audits/5"
identifiers:
- type: other
value: "skillstore:zhangchenlai-dev-api-doc-generator:audit:5"
description: "Skillstore immutable audit report identifier"
Skillstore 評分
評分依據 證據置信度: 中你可以打造什麼
為新服務撰寫文件
根據路由處理常式和 schema 備註產生 API 參考內容的初稿。
準備整合指南
將端點詳細資料轉換為供外部合作夥伴使用的清楚請求範例。
標準化團隊 API 規格
將分散的端點備註轉換為一致且以 OpenAPI 為導向的結構。
試試這些提示
為這些端點產生 API 文件。包含方法、路徑、用途、參數、請求範例和回應範例。
檢視這段 API 程式碼，並建立包含 paths、methods、request bodies、response schemas 和 common errors 的 OpenAPI 3.0 大綱。
將這份端點文件轉換為 Postman collection 指引。包含資料夾、請求名稱、標頭、變數和範例主體。
將這些路由與目前的 API 文件進行比較。找出缺少的端點、不清楚的 schema、不一致的範例，以及過時的回應描述。
最佳實務
- 同時提供路由程式碼、schema 定義和驗證詳細資料。
- 要求範例符合真實的請求與回應形狀。
- 在與客戶分享前，先審查產生的 OpenAPI 內容。
避免
- 不要在未根據實作驗證的情況下發布產生的規格。
- 不要省略驗證、錯誤處理或速率限制背景。
- 不要將佔位符範例視為正式環境的合約詳細資料。
常見問題
此技能可以建立 OpenAPI 3.0 文件嗎？
它可以直接建立 Postman collections 嗎？
它會檢查即時 API 嗎？
哪種輸入最適合？
它對非英語團隊有用嗎？
產生的文件是最終版本嗎？
開發者詳細資訊
授權
MIT
作者版本
v1.0.0
Skillstore 修訂
r1
引用
64ca8af0f54a325752f08bd54e52151061ea659a
維護新鮮度
2026/7/20
使用量
2 次下載 · 1 次瀏覽
檔案結構
📄 SKILL.md