简诗 AI 接口文档编写

为什么需要 API 文档自动编写

API 文档混乱是开发者常见的痛点：接口信息分散在代码注释、聊天记录和零散的 README 中，端点用途不明确，认证方式写不清楚，错误码说明缺失，示例代码与实际响应脱节。这种状况会导致接入成本高、联调效率低，甚至因误解接口行为引发线上故障。

技能如何工作

核心能力是按规范流程生成结构化文档：

• 信息收集：先确定 API 类型（REST/GraphQL/WebSocket/gRPC）、认证方式（API key/OAuth/JWT）、基础 URL 和版本策略、端点列表及用途、请求响应格式、限流规则
• 结构搭建：按 references/documentation-structure.md 覆盖所有必选章节（概述、认证、端点、错误、限流、SDK、Webhook、GraphQL），常见操作优先排序
• 模板应用：REST API 严格遵循 references/output-template.md，替换占位符为真实示例数据，同时展示请求与响应；GraphQL 则适配 schema/query/mutation/subscription 示例
• 错误与限流文档化：包含标准错误格式、常见错误码、排障指引、限制条件、需检查的响应头，以及 429 处理说明
• 多语言示例支持：提供 curl、JavaScript、Python 代码片段，可关联 SDK、Postman 集合或 OpenAPI 规范
• 质量验证：交付前对照 references/best-practices.md 的检查清单核对

适用边界与注意点

安全与执行边界明确：不自动安装依赖、修改系统权限、创建持久化任务或执行下载内容；涉及发送/发布/删除/付款/部署等外部写入时，先展示目标与影响并获取用户确认；凭据仅用于指定官方服务，不回显、不记录、不转发；命令和代码默认作为参考，仅在用户明确要求且目标范围清晰时才执行。