API文档生成器Skill afrexai-api-docs

API 文档生成器

根据端点描述生成生产就绪的 API 文档。输出 OpenAPI 3.0 规范、Markdown 参考文档和 SDK 快速入门指南。

使用方法

描述您的 API 端点，本技能将生成：

1. OpenAPI 3.0 规范 — 机器可读，可导入 Swagger/Postman
2. Markdown 参考文档 — 包含示例的人类可读端点文档
3. SDK 快速入门指南 — 面向开发者的即用型集成指南

操作说明

当用户描述 API 端点（路由、方法、参数、响应）时：

1. 生成完整的 OpenAPI 3.0 YAML 规范
2. 创建 Markdown 文档，包含：
   • 认证部分
   • 每个端点：方法、路径、描述、参数表、请求/响应示例
   • 错误代码参考
   • 速率限制说明
3. 生成包含 curl 示例和常用语言代码片段（Python、JavaScript、Go）的快速入门指南

输出格式

# openapi.yaml — 完整的 OpenAPI 3.0 规范

# API 参考文档 — 人类可读的文档

# 快速入门指南 — 集成示例

质量标准

• 每个端点都必须有请求和响应示例
• 使用真实的示例数据，而非“字符串”或“示例”
• 包含错误响应（400、401、403、404、500）
• 记录分页、过滤和排序模式
• 注明破坏性变更和版本控制策略

提示

• 粘贴您的路由文件或控制器代码以自动提取信息
• 适用于 REST、GraphQL（模式优先）和 gRPC（proto 优先）
• 与 CI/CD 结合，可在每次部署时自动生成文档

---

由 AfrexAI 构建 — 为快速交付的团队提供 AI 驱动的商业工具。