SuperAPI AI 工具集

api-doc

编程与开发

查看项目

更新于 10-15 23:45

技能介绍

用途:面向后端与接口开发者,帮助编写清晰、开发者友好的 API 文档,覆盖 OpenAPI 3.0/Swagger 规范与 RESTful 设计实践。

主要能力:从零生成完整 OpenAPI/Swagger 文档;为已有接口补全说明与示例;评审 API 设计并给出 RESTful 建议;设计统一错误码与错误响应格式;编写接口变更记录与迁移指南;支持将 OpenAPI YAML 转为 Markdown 表格、生成 Postman Collection JSON、补充 WebSocket 事件文档。

使用方式:先确认 API 用途、涉及资源、支持操作、认证方式(Bearer Token/API Key/OAuth 2.0)与输出格式;再按 RESTful 原则设计路径与方法(如 GET /api/v1/users、POST /api/v1/users、PATCH /api/v1/users/:id),URL 用名词复数、kebab-case、版本号放路径、嵌套不超过两层;每个接口包含路径方法、功能说明、Path/Query/Header/Body 参数、请求示例、成功响应示例、错误响应与错误码、认证要求。输出可为 OpenAPI YAML 或 Markdown 表格,统一响应格式为 code/message/data,错误码按认证、参数、业务、系统分段。

适用场景:新接口文档编写、存量接口文档补全、API 设计评审、错误码体系设计、版本变更说明。

限制:不提供后端代码实现、API 网关配置、接口自动化测试、性能压测、在线 Swagger UI 部署。资料未提供具体安装命令与收费信息。