SuperAPI AI 工具集

api-doc-generator

编程与开发

查看项目

更新于 10-16 06:50

技能介绍

用途:根据 OpenAPI Specification 生成人类可读的 Markdown 文档,与 OAS 文件分离,便于构建文档网站或 wiki。

主要能力:生成 README.md 概览页,包含 API 标题、版本、描述、服务器/基础 URL 列表,以及按标签组织的目录和接口页面链接;为每个操作生成独立页面,包含 HTTP 方法与路径、描述与摘要、参数表(path、query、header)、请求体详情、带真实示例值的 curl 命令、响应示例与状态码、响应码表。curl 示例会自动使用正确的 HTTP 方法、servers 中的基础 URL、替换为示例值的路径参数、查询参数、请求头及格式化的 JSON 请求体,规范提供多个示例时会生成多个。

使用方式:先安装依赖 pip install pyyaml,然后运行 python3 skills/api-doc-generator/scripts/generate_docs.py path/to/spec.yaml [output-dir],未指定输出目录时默认为 ./docs。也可直接让 Claude 生成,例如“Generate markdown documentation from my API spec at path/to/spec.yaml”。

适用场景:需要从 API 规范创建开发者文档、为每个接口提供 curl 示例、构建文档网站或 wiki、将文档提交到仓库 docs/ 目录、发布到 GitHub Pages、导入 wiki 或文档平台,或作为独立文件分享给 API 使用者。每个接口独立成文件,便于直接链接、单独更新或按标签分类组织。

限制:资料未提供对特定 OpenAPI 版本的支持范围、错误处理、自定义模板或主题等能力说明,暂未提供。