赋予您的智能体使用 OpenAPI 和 Swagger 标准创建全面、交互式且对开发人员友好的 API 文档的能力。
当您需要生成正式的 OpenAPI (Swagger) 规范时
当您想在项目中添加像 Swagger UI 这样的交互式文档时
当您需要带有实际代码示例的清晰 API 参考指南时
指定 API 端点、请求体以及成功/错误响应
生成 YAML 或 JSON 格式的 OpenAPI 3.0 规范文件
在源代码中添加 JSDoc 或装饰器注释以进行自动生成
将文档整理到 README、入门指南和参考章节中
你
我需要记录我们新的用户身份验证 API，以便我们的前端团队可以开始集成它。
Agent
我将为您的身份验证端点创建一个完整的 OpenAPI 规范。我将包含 'POST /v1/auth/login'，并附带清晰的请求体架构，以及成功（带 JWT 的 200 OK）和失败（401 Unauthorized）情况的示例。我还将提供一个带有 curl 示例的“入门指南”，以便您的团队可以使用 Swagger UI 立即测试 API。
赋予您的智能体根据 Diátaxis 框架的四个象限创建专家级技术文档的能力。
Gives your agent the ability to generate comprehensive, standardized technical documentation for object-oriented components, complete with architecture diagrams and API references.
赋予您的代理通过分析源代码和实现模式来更新面向对象组件文档的能力。
Gives your agent the ability to design high-quality RESTful and GraphQL APIs following industry best practices and OpenAPI standards.
赋予您的代理为带有自适应卡的 TypeSpec API 插件添加 GET、POST 和 DELETE 等 RESTful 操作的能力。
