用途:把原始 API 规格、端点描述或 Postman 导出内容,转换为面向开发者的清晰文档,遵循接近 OpenAPI 的书写惯例,输出可直接用于开发者门户、README 或 Notion/Confluence 页面。
主要能力:为每个端点生成方法、路径、摘要、描述、认证方式、请求头、路径参数、查询参数、请求体、成功响应、错误码表,以及至少两种语言的代码示例(默认 cURL 与 Python)。错误码至少覆盖 400、401/403、404、429、500,并给出解决建议。列表端点需说明分页。字段需标注类型、是否必填、枚举与取值范围。
使用方式:提供 API 或端点细节、认证方式、Base URL、API 版本、速率限制、目标读者、输出格式(Markdown 或纯文本;不生成 OpenAPI YAML)。若缺少非核心信息,可先按合理假设补全并标注“assumed, confirm”,在末尾列出假设;仅当核心主题缺失时才先提问。随附参考文件 references/example-first-docs.md 与模板 templates/endpoint-entry.md,可在需要时使用。
适用场景:编写 API 参考文档、开发者指南、将 Postman 集合转为文档、为产品 API 撰写开发者文档。
限制:不产出 OpenAPI YAML;代码示例需使用真实 Base URL 与明显虚构的占位凭证,避免 YOUR_ENDPOINT 之类占位符;不得只写正常路径;未提供的信息(如具体价格、平台支持)暂未提供。