技能 API Documenter
📝
API Documenter
安全
生成 API 文档
开发者花费数小时手动编写 API 文档。此技能可自动从代码或 OpenAPI 规范生成全面的 API 文档，节省时间并确保一致性。
支持: Claude Codex Code(CC)
1
下载技能 ZIP
2
在 Claude 中上传
前往 设置 → 功能 → 技能 → 上传技能
3
开启并开始使用
测试它
正在使用“API Documenter”。 为返回用户档案数据的 GET /users/{id} 端点生成 API 文档
预期结果:
- # GET /users/{id}
- Retrieves a user profile by unique identifier.
- ## Request
- - Method: GET
- - Path: /users/{id}
- - Auth: Bearer token required
- ## Response 200
- ```json
- {"id": "user_123", "name": "John Doe", "email": "john@example.com"}
- ```
正在使用“API Documenter”。 为宠物 API 记录此 OpenAPI 规范
预期结果:
- # Pet Store API
- ## Overview
- RESTful API for managing pet inventory.
- ## Endpoints
- - GET /pets - List pets
- - POST /pets - Add pet
- - GET /pets/{id} - Get pet
- - DELETE /pets/{id} - Remove pet
安全审计
安全v1 • 2/24/2026
This is a prompt-only skill that generates API documentation. Static analysis found no executable code, no network requests, no filesystem access, and no external command execution. The skill contains only natural language prompts for generating documentation content.
0
已扫描文件
0
分析行数
0
发现项
1
审计总数
未发现安全问题
审计者: claude
质量评分
38
架构
100
可维护性
85
内容
50
社区
100
安全
74
规范符合性
你能构建什么
内部服务的快速 API 文档
在开发冲刺期间快速为内部微服务生成文档
公共 API 文档
为公共 API 产品创建精美、面向用户的文档
遗留 API 文档恢复
通过分析代码为未文档化的遗留 API 生成文档
试试这些提示
基本文档请求
Generate API documentation for the following endpoint: [paste endpoint code or description]
完整 API 文档
Create comprehensive API documentation for this OpenAPI specification: [paste OpenAPI JSON/YAML]
多语言示例
Generate API documentation with code examples in Python, JavaScript, and curl for: [paste endpoint details]
Markdown 文档
Create polished markdown API documentation with sections for overview, endpoints, authentication, error codes, and examples: [paste API specification]
最佳实践
- 提供完整的 OpenAPI 规范以获得最佳效果
- 在输入中包含身份验证详细信息
- 发布前审查生成的示例以确保准确性
避免
- 期望对 API 端点进行实时测试
- 提供不完整或模糊的端点描述
- 假设技能了解您特定的内部约定
常见问题
此技能接受哪些输入格式？
此技能接受 JSON 或 YAML 格式的 OpenAPI 规范，以及 API 端点的自然语言描述。
此技能可以测试我的 API 端点吗？
不，此技能仅生成文档。它无法发出实际的 HTTP 请求来测试端点。
代码示例支持哪些编程语言？
此技能可以生成 JavaScript、Python、curl、Ruby、Go 和其他常用语言的示例。
这适用于 GraphQL API 吗？
目前此技能专注于 REST API。GraphQL 支持可能会在未来版本中添加。
生成的文档有多准确？
准确性取决于输入规范的完整性。完整的 OpenAPI 规范会产生最准确的文档。
我可以自定义输出格式吗？
是的，您可以在提示中指定 markdown、HTML 或其他格式。默认输出为 markdown。