SuperAPI AI 工具集

write-openapi

编程与开发

查看项目

更新于 10-15 16:41

技能介绍

用途:在 GitBook 中编写、配置、组织和排查 OpenAPI/Swagger API 参考文档。GitBook 将 OpenAPI 文档渲染为可交互、可测试的 API 参考块,大部分定制通过规范内的 x-* 扩展完成,而非 GitBook UI。

主要能力:支持 Swagger 2.0 与 OpenAPI 3.0;webhooks 需 3.1,parent 标签需 3.2+(3.0.x/3.1.x 用 x-parent)。可导入或更新规范、生成参考页、按 tag 组织导航、配置 Test it 运行器(由 Scalar 驱动)、标记实验/弃用/隐藏端点、通过 CI/CD 自动发布。

使用方式:规范来源可为文件或 URL,URL 每 6 小时自动刷新。可通过 GitBook MCP、REST API(https://api.gitbook.com/v1,需 GITBOOK_TOKEN)或 CLI 操作。CLI 命令:gitbook openapi publish --spec <spec-name> --organization <organization-id> <path-or-url>。MCP 安装:claude mcp add --transport http gitbook-mcp https://mcp.gitbook.com/mcp。

适用场景:为 API 生成可测试的交互式参考文档,并在文档站点中维护。

限制:URL 来源的规范常因 CORS 无法加载或 Test it 失败,需 API 允许跨域 GET,或用 x-enable-proxy: true 走 GitBook 代理(仅转发 servers 中列出的 URL)。令牌不得写入文件、回显或提交。具体扩展 YAML 与运行器配置细节见随附参考文件。