這個工作流程協助開發人員建立完整的 API 文件，引導他們完成 OpenAPI 規格建立、開發人員指南撰寫、程式碼範例生成以及互動式文件設定。
下载技能 ZIP
在 Claude 中上传
前往 设置 → 功能 → 技能 → 上传技能
开启并开始使用
测试它
正在使用“api-documentation”。 使用 @api-documentation 工作流程為我的使用者管理 API 建立文件
预期结果:
我將引導您完成 7 個階段的完整 API 文件建立：
**第 1 階段：API 探索**
- 盤點您的端點
- 記錄請求/回應格式
- 識別驗證需求
[引導每個階段的具體動作]
正在使用“api-documentation”。 為我的電子商務 API 建立 OpenAPI 規格
预期结果:
這是您的 OpenAPI 規格結構：
```yaml
openapi: 3.0.0
info:
title: E-Commerce API
version: 1.0.0
paths:
/products:
get:
summary: List products
responses:
200:
description: Successful response
```
安全审计
安全Security analysis confirms this is a safe documentation workflow skill. The static analyzer flagged 28 instances of 'external_commands' (Ruby/shell backtick execution) and 9 instances of 'weak cryptographic algorithms', but both are false positives. The backticks in the file are Markdown code spans (e.g., `api-documenter`) used for skill name references, not shell command execution. No actual security risks were identified.
中风险问题 (2)
质量评分
你能构建什么
新 API 專案文件
從頭開始為新的 REST API 建立完整文件，包括 OpenAPI 規格、開發人員指南和互動式文件。
舊版 API 文件更新
更新並現有化現有的 API 文件，包括 OpenAPI 規格、程式碼範例和互動式試用功能。
內部 API 入口網站建立
為內部團隊建立內部 API 入口���站，包含完整的文件、程式碼範例和整合指南。
试试这些提示
使用 @api-documentation 工作流程為我的 REST API 建立文件。我有端點清單，需要協助產生 OpenAPI 規格和開發人員指南。
使用 @api-documentation 為我的 API 建立 OpenAPI 規格。此 API 透過 JWT 進行驗證，並包含使用者、產品和訂單的端點。
使用 @api-documentation 工作流程為我的現有 API 文件新增程式碼範例。我需要 Python、JavaScript 和 cURL 的範例。
使用 @api-documentation 為我的現有 OpenAPI 規格設定 Swagger UI 和 Redoc 的互動式文件。設定試用功能。
最佳实践
- 在產生文件之前，先從 API 探索開始以了解所有端點
- 使用自動化讓 OpenAPI 規格與實際 API 變更保持同步
- 測試所有程式碼範例以確保在生產環境中正常運作
避免
- 略過探索階段，直接跳到文件產生
- 在未驗證 API 規格準確性的情況下產生文件
- 建立 API 變更時永不更新的靜態文件