SuperAPI AI 工具集

api-documentation-writer

编程与开发

查看项目

更新于 10-16 07:25

技能介绍

用途:为 API 生成完整、面向开发者的文档,涵盖端点描述、请求与响应示例、认证指南、错误码和 SDK 等。

主要能力:提供三份参考文件——documentation-structure.md(需覆盖的章节:概览、认证、端点、错误、速率限制、SDK、Webhook、GraphQL)、output-template.md(标准 REST Markdown 模板及示例)、best-practices.md(最佳实践、开发者体验建议与输出质量检查清单)。支持 REST、GraphQL、WebSocket、gRPC 类型,以及 API key、OAuth、JWT 等认证方式。

使用方式:先收集 API 信息(类型、认证方式、基础 URL 与版本策略、端点及用途、请求/响应格式、速率限制);按 documentation-structure.md 构建结构,将最常用操作排在前面;REST 按 output-template.md 生成,GraphQL 则适配 schema、query、mutation、subscription 示例;用真实示例数据替换占位符并同时展示请求与响应;记录标准错误响应格式、常见错误码、排查指引、限制、需检查的响应头及 429 处理方式;提供 curl、JavaScript、Python 等多语言代码示例,并链接 SDK、Postman 集合或 OpenAPI 规范;交付前按 best-practices.md 清单核验质量。

适用场景:编写 REST 端点文档、创建 OpenAPI 规范、记录 GraphQL schema、生成 Webhook API 开发者文档、编写 API 认证指南。

限制:资料未提供具体安装命令、收费方式、平台支持范围及实际效果说明。