用途:为 REST、GraphQL、WebSocket、gRPC 等 API 生成面向开发者的完整文档,帮助集成方快速上手。\n\n主要能力:先收集 API 类型、认证方式(API Key、OAuth、JWT)、基础 URL 与版本策略、端点用途、请求/响应格式、限流与限制;随后产出结构化文档,包含概述与核心能力、快速开始清单、认证(凭据获取、令牌位置、示例请求、令牌刷新)、基础 URL 与版本(生产与沙箱、版本格式、变更日志)、逐端点说明(HTTP 方法与路径、参数、请求头、请求体结构、响应码、响应体结构、curl/JavaScript/Python 示例、格式化 JSON 响应)、错误处理(标准错误格式、常见错误码、排障)、限流(限额、窗口、响应头、处理 429)、SDK 与库(官方与社区、安装说明)、Webhook(事件、设置、负载示例、安全校验)。对 GraphQL 可改为展示 schema、查询、变更、订阅、变量与指令。\n\n使用方式:用户提出“为我的 REST 端点写 API 文档”“为 GraphQL schema 写文档”“生成 webhook 文档”“写认证指南”等需求时触发,按上述信息项收集后生成。\n\n限制:效果依赖用户提供的 API 信息,未提供的事实(具体产品平台、收费、价格、实际效果)暂未提供;不能编造接口、参数或示例数据。
api-documentation-writer
编程与开发
更新于 10-16 02:38