SuperAPI AI 工具集

api-documentation

写作与研究

查看项目

更新于 10-15 19:53

技能介绍

用途:当 API 契约已经存在、需要发布供开发者使用的文档时使用本技能。它只负责写文档,不负责重新设计 API、实现后端、认证中间件或测试策略。

主要能力:选择合适的文档形态(参考文档、快速开始、认证指南、Webhook 指南、SDK 文档、迁移或发布说明);说明认证、请求、响应、错误与限制;提供可复制粘贴的示例;记录迁移与兼容性说明;整理文档门户入口。

使用方式:先确定受众、事实来源(OpenAPI、GraphQL SDL、端点表、代码注解或既有文档)、所需文档面与成熟度(新发布、集成中、迁移或弃用);再按开发者工作流排序内容:用途、前置条件与认证、首次成功请求、请求与响应示例、错误与限制与重试与分页、进阶模式、变更说明。示例应语法有效、与契约一致、不含真实密钥,优先用 curl,并在需要时给一个 SDK 或语言示例。输出通常包含:文档目标、快速开始或入口、参考覆盖、示例、运维语义说明(认证、错误、限流、重试、分页、迁移)、以及交接说明。

边界与交接:契约设计、资源建模、版本策略或 OpenAPI/GraphQL 设计交由 api-design;JWT、OAuth、会话、中间件等认证实现交由 authentication-setup;后端实现、handler、resolver、持久化不属本技能;测试计划与契约测试交由 backend-testing;面向最终用户的教程交由 user-guide-writing。若事实来源缺失或不稳定,应说明并将契约工作交回 api-design,而不是自行编造细节。

限制:不重新设计 API,不写后端实现,不替代测试策略,不做仅“从注解生成 Swagger”而无质量打磨的任务。

参考资料:references/doc-surface-selection.md、references/publishing-and-examples.md,以及 OpenAPI Specification、Swagger UI、Redocly。