用途
generate-api-docs 是一个用于生成 API 文档的技能。它针对当前项目的 API 端点,创建完整的接口文档,输出格式为 OpenAPI/Swagger 规范,或遵循项目已有的文档标准。
主要能力
根据资料,该技能生成的文档包含以下内容:
API 概览
- 服务描述与用途
- 基础 URL 与版本信息
- 认证与授权要求
- 限流与使用策略
端点文档
- HTTP 方法与 URL 路径
- 请求参数(路径参数、查询参数、请求体参数)
- 请求与响应模式,含数据类型
- 示例请求与响应
- 可能的错误码与错误信息
数据模型
- 定义所有数据模型与模式
- 字段说明与约束
- 模型之间的关系
- 示例载荷
使用示例
- 常见用例场景
- SDK/客户端库示例
- CURL 命令示例
- 错误处理示例
使用方式
资料中未提供具体的安装命令、调用方式或配置步骤,暂未提供。
适用场景
适用于需要为现有 API 端点生成或规范化接口文档的开发工作,尤其是希望产出 OpenAPI/Swagger 规范或与项目文档标准保持一致的情况。
限制
资料中未说明该技能支持的编程语言、框架、平台或具体限制条件,暂未提供。