openapi-lookup
Installation
SKILL.md
OpenAPI 接口查询
通用的 OpenAPI/Swagger 文档查询技能,适用于任何后端项目。当用户要对接某个接口、询问接口的入参或响应结构时,运行本技能的脚本获取最新且完整的定义,不要凭记忆或旧代码推断字段。
直接 curl 拉文档会因为 $ref 引用而看不到完整结构,务必用本脚本(它会递归展开 $ref)。
首次配置
当 config.json 中 docsUrl 为空时,必须先向用户询问 OpenAPI 文档地址。使用问答 UI 收集以下信息并写入 config.json:
- 询问用户提供后端 OpenAPI/Swagger 文档地址(如
http://host:port/v3/api-docs或本地 JSON 文件路径) - 将用户输入的值写入
skills/openapi-lookup/config.json的docsUrl字段 - 确认配置成功后,继续执行查询
如果文档需要 Basic Auth 认证,可在
config.json中额外配置username和password字段(可选)。参考config.example.json。
文档来源配置
脚本按以下优先级确定 OpenAPI 文档地址,支持 http(s) 地址或本地 JSON 文件路径: