用途:为 API 编写文档,包括创建 OpenAPI/Swagger 规范、SDK 文档、API 指南,以及生成 Postman 集合;也可从代码中提取端点并推断类型,生成结构化文档。
主要能力:提供 OpenAPI 3.0.3 模板,涵盖 info、servers、paths、components 等结构;能定义端点(如 GET /users、POST /users)、查询参数、请求体、响应结构,以及 User、CreateUser 等 schema 和 bearerAuth 安全方案。文档结构示例包含认证说明、端点说明、参数表、JSON 响应示例和错误码表(400、401、404、500 等)。
使用方式:根据资料,典型输入如“Document the user API”会创建包含端点、schema、示例和错误码的 OpenAPI 规范;输入“Generate API docs from code”会提取端点、推断类型并生成结构化文档。资料未提供具体安装命令或调用命令。
适用场景:新 API 文档化、创建 OpenAPI/Swagger 规范、生成 SDK 文档、编写 API 指南、创建 Postman 集合。
限制:资料未说明支持的编程语言、平台、是否收费、价格、实际输出格式或效果保证;也未提供具体的安装与运行步骤,这些信息暂未提供。