下载技能 ZIP
在 Claude 中上传
前往 设置 → 功能 → 技能 → 上传技能
开启并开始使用
测试它
正在使用“api-documentation-generator”。 记录创建用户账户的 POST /users 端点
预期结果:
- ## 创建用户
- 创建新的用户账户。
- 端点:POST /api/v1/users
- 身份验证:必需(Bearer token)
- 请求体:email(必需)、password(必需,最少 8 个字符)、name(必需)
- 成功响应:201 Created,返回包含 id、email、name、createdAt 的用户对象
- 错误响应:400 验证错误、409 邮箱已存在、401 未授权
- 提供 cURL、JavaScript fetch 和 Python requests 示例
正在使用“api-documentation-generator”。 记录带有 ID 参数的 GraphQL GetUser 查询
预期结果:
- ## 用户查询
- 按 ID 获取用户信息。
- 查询:GetUser($id: ID!)返回包含 id、email、name、role、posts 的用户对象
- 变量:id(必需,ID 类型)
- 响应:包含用户和嵌套 posts 数组的数据对象
- 错误:USER_NOT_FOUND,包含扩展代码和 userId
安全审计
安全This skill is a documentation generator that produces API documentation from codebases. Static analysis flagged 65 external_commands and 12 network patterns, but all are FALSE POSITIVES. The SKILL.md file contains only instructional markdown with code examples formatted using markdown backticks (not shell execution). URLs are documentation examples (api.example.com), not actual network calls. No executable code, no cryptographic implementations, and no system commands exist. Safe for publication.
质量评分
你能构建什么
REST API 文档
为 REST API 生成完整的端点文档,包含请求/响应示例、身份验证详细信息和错误代码
GraphQL 架构文档
创建查询和变更文档,包含变量规范、响应结构和错误格式
开发者门户内容
生成全面的 API 参考文档,包括入门指南、身份验证设置和使用指南
试试这些提示
记录此 API 端点:[粘贴代码]。包含 HTTP 方法、URL 路径、请求参数、响应格式和一个代码示例。
为此代码库生成完整的 API 文档:[粘贴文件]。包含所有端点、身份验证要求、请求/响应架构、错误代码,以及 cURL、JavaScript 和 Python 的代码示例。
将此 API 代码转换为 OpenAPI 3.0 规范:[粘贴代码]。包含所有路径、组件、安全方案和示例值。
根据这些代码更改更新 API 文档:[显示差异]。识别新端点、修改的参数和更改的响应格式。提供更新的文档部分。
最佳实践
- 使用注释或注解将文档与代码保持紧密联系,确保它们保持同步
- 包含在沙箱或预发布环境中测试过的可运行代码示例
- 记录所有错误代码和边缘情况,而不仅仅是成功场景
避免
- 使用 foo 和 bar 等占位符数据编写文档示例,而不是使用真实值
- 仅记录正常路径场景,不涵盖错误处理
- 将文档创建为单独的产物,代码更改时被遗忘
常见问题
此技能支持哪些编程语言?
这可以生成 OpenAPI/Swagger 规范吗?
此技能会测试记录的端点吗?
这可以记录 GraphQL API 吗?
当我的 API 更改时,如何保持文档更新?
这可以创建 Postman 集合吗?
开发者详情
作者
sickn33许可证
MIT
仓库
https://github.com/sickn33/antigravity-awesome-skills/tree/main/skills/api-documentation-generator引用
main
文件结构
📄 SKILL.md