SuperAPI AI 工具集

api-documentation

写作与研究

查看项目

更新于 10-15 20:30

技能介绍

用途:自动生成并维护 API 文档,涵盖 API 参考、入门教程、认证指南、错误处理与限流策略,并从代码注释或 OpenAPI/Swagger 规范提取内容。

主要能力:生成 API 参考文档与多语言用法示例;搭建 Swagger UI、Redoc、Stoplight Elements 等交互式文档并支持 try-it-out;导出 HTML、Markdown、PDF、Postman 集合及 SDK;从 JSDoc、TypeDoc、Python docstring(FastAPI)生成规范。

使用方式:以 @api-documentation 调用,可加参数如 --from-openapi、--interactive、--export-postman、--generate-sdk。可用 swagger-ui-express、Redoc CLI、Stoplight Elements、Docusaurus、Slate、MkDocs、rdme 等工具。Redoc CLI 示例:npm install -g redoc-cli;redoc-cli bundle openapi.yaml -o docs/index.html;redoc-cli serve openapi.yaml --watch。

适用场景:为 REST API 建设文档站点、生成多格式交付物与交互式调试页面。

限制:资料未提供该技能的具体安装步骤、收费与平台支持信息,需以官方文档为准;示例中的域名、令牌与端口仅为占位。