API Docs Studiov1.0.1

将 OpenAPI 3.0 JSON 合约转为可搜索的端点文档。

看看你能制作什么

跳过交互式示例

正在载入可操作示例…

打开示例
直接操作示例,在示例内滚动以浏览更多内容。
由此技能生成可搜索 API 文档与可移植请求套件

虚构七操作契约 · 实际请求文件与已检查示例

打开完整示例

你将获得什么

可搜索 API 文档与可移植请求套件

你能制作什么

  • 将 OpenAPI 3.0 JSON 合约转为可搜索的端点文档。
  • 切换响应示例,查看 cURL、Python 和 Fetch 请求。
  • 导出 Postman 集合,按支持的模式子集检查捕获的响应。
查看交付文件6 组
  • index.html + original openapi.json
  • reference.md
  • postman.json
  • snippets/<operation>.sh + .py + .mjs
  • quality.json
  • delivery-manifest.json

适合使用

适合依据明确合约制作可移植文档的 API 团队。

了解使用边界

支持已说明的 OpenAPI 子集;缺失示例会明确标为缺失。

关于这项技能

功能:最多 50 个操作,支持标量路径、查询和请求头参数、本地 Schema 引用、简单 Bearer 或请求头密钥认证、响应状态切换、端点搜索,以及 cURL/Python/Fetch 请求视图。未提供的示例会明确标为缺失。

交付:离线 index.html、原始 openapi.json、reference.md、可导入且令牌变量为空的 postman.json、每个操作的三种请求文件、quality.json 与 SHA-256 清单。虚构 Northstar 契约包含 7 个已说明的操作。

展开完整工作流说明

首次运行:仅需 Python 3.10+ 标准库。运行 scripts/build-docs.py --spec examples/openapi.json --demo --output ./api-reference。使用 scripts/check-response.py,传入已声明的操作、状态码与已捕获的 JSON 对象响应,单独执行本地结构检查。

检查:必填字段、类型、枚举、可空值、额外属性、长度与数值边界,以及数组元素唯一性。JSON 数字按数值比较,布尔值保持独立。未知语义关键字、不支持的参数序列化与服务器覆盖会明确失败。

验证:已生成 7 个操作的导出文件,解析复用 Schema,检查有效与无效的响应案例,保留空值请求体,核查请求转义与 Markdown 代码围栏。已操作搜索、响应切换、语言选择并实际下载 Postman 集合。

范围:仅支持 OpenAPI 3.0 JSON 和明确限定的 Schema 子集;YAML、OpenAPI 3.1、格式、组合、正则与递归 Schema 需要明确转换或其他工具。生成的文档不会执行请求。契约结构检查不能证明服务器行为、权限或认证正确。

版本 1.0.1:Skillrove 原创工具与示例采用 MIT 许可,借鉴采用 MIT 许可的 API 文档工作流,并保留其许可文本与固定版本署名。单次购买 $4.99,有效高级会员包含此内容包。

从内容包到第一次产出

让助手带你完成首次产出

选择起点,提供已有内容,让助手检查环境并先完成一份成果。

查看示例结果

需要购买权限。将内容包解压到下方项目目录,或让助手按照安装指南完成安装。 .agents/skills/api-docs-studio

提供项目名称、受众,以及已有内容或图片即可开始;助手会追问缺少的必要信息。

3. 让助手引导首次产出

内容包位置: .agents/skills/api-docs-studio

使用 .agents/skills/api-docs-studio 中的 API Docs Studio。先读取 SKILL.md,检查本机依赖,再以 examples/openapi.json 为起点。先生成一份最小可检查成果,再调整为我的内容。保留虚构示例标识,不编造业务事实;缺失必要信息时先追问。

将成果写入全新目录,保留已有文件。检查实际输出(index.html + original openapi.json、reference.md、postman.json),打开可视成果并说明失败项。未完成的依赖检查不能算成功;任何付费服务先征求同意,不自动发布。
完成前检查
  • 开始生成前检查依赖
  • 实际文件可打开,并已替换为你的内容
  • 可编辑源文件已保存到新目录
已完成首次产出?分享使用体验 →
安装选项与技术要求
US$4.99 · MIT 许可Python 3.10+ · 离线运行无需 API 密钥或付费服务
  1. 01

    选择你的助手

    以下使用项目目录。请在助手中打开该项目,并从项目根目录执行终端命令。

    Codex 目录指南

    内容包目录 .agents/skills/api-docs-studio

  2. 02

    安装内容包

    下载并解压到上面的目录,保留所有文件,并让 SKILL.md 直接位于该目录中。

    下载需要已验证账号与购买权限。如果技能已安装,请选择新目录。

  3. 03

    运行包内示例

    手工示例命令与技术说明

    查看 SKILL.md 和生成脚本,确认运行依赖后执行:

    cd .agents/skills/api-docs-studio
    python3 scripts/build-docs.py --spec examples/openapi.json --demo --output ./api-reference
    第一次产出

    搜索端点并选择操作,切换 cURL/Python/Fetch,查看已声明的响应状态。下载 Postman 并按原始契约核对 7 个请求。运行 check-response.py --spec examples/openapi.json --operation getWorkspace --status 200 --response examples/workspace-response.json;再删除一个必填字段,确认检查会拒绝。

    仅需 Python 3.10+ 标准库,可离线运行。支持 OpenAPI 3.0 JSON、本地无环引用与已说明的 Schema 子集。响应检查器接受 JSON 对象。不会执行请求;令牌保持为空或使用环境变量占位符。服务器行为、认证和不支持的 Schema 语义需要单独测试。

    如果 api-reference 已存在,请将输出改为 ./api-reference-2。现有文件不会被覆盖。

    想让助手代为操作?

    使用 .agents/skills/api-docs-studio 中的 API Docs Studio,查看 SKILL.md 和 scripts/build-docs.py,将 examples/openapi.json 运行到新输出目录,向我展示全部生成的文件,并清楚标记虚构示例内容。

评论

分享你的第一次产出

使用过这个工作流?用真实评价帮助其他人选择。

选择这项技能之前

如何获取 API Docs Studio?

单独购买此内容包的标价为 4.99 美元。高级内容包下载需要已确认的购买或有效会员。助手订阅、模型访问权限与外部服务额度独立计算。

哪些助手可以使用这项技能?

此版本列出的预期安装助手为 Codex, Claude Code, Cursor。运行前请检查内容包的依赖与权限。标签不代表每项工作流已在所有助手中测试。

此工作流可以生成哪些文件?

版本 1.0.1 的说明列出:index.html + original openapi.json;reference.md;postman.json;snippets/<operation>.sh + .py + .mjs;quality.json;delivery-manifest.json。部分文件或导出为可选项,请按内容包的要求配置并检查最终结果。

使用结果前需要检查什么?

仅需 Python 3.10+ 标准库,可离线运行。支持 OpenAPI 3.0 JSON、本地无环引用与已说明的 Schema 子集。响应检查器接受 JSON 对象。不会执行请求;令牌保持为空或使用环境变量占位符。服务器行为、认证和不支持的 Schema 语义需要单独测试。

$4.99单次购买