SuperAPI AI 工具集

swagger-api-query

编程与开发

查看项目

更新于 10-16 01:27

技能介绍

用途:按需索引和查询 OpenAPI/Swagger JSON 文档,避免一次性加载完整规范,适合接口数量庞大的项目。

主要能力:提供 list-tags(列出 API 分类)、list-all(列出全部接口索引)、tag(按标签查询)、search(关键词搜索)、detail(查看接口详情)、schema(查看模型定义)等命令,支持 --format json 结构化输出,便于下游程序消费。

使用方式:脚本位于 scripts/swagger_query.py,需 Python 3.6+ 与 OpenAPI/Swagger JSON 文档。文档路径解析顺序为:显式 --spec <path> 参数、当前或父目录下的 api-docs.json、技能目录或其父目录下的 api-docs.json;未找到时会显示已检查路径并建议使用 --spec。建议先 list-tags、search 或 tag 缩小范围,再对目标接口调用 detail,需要字段定义时再调用 schema。默认文本输出,仅在下游程序需要时使用 --format json。

示例命令:python skills/swagger-api-query/scripts/swagger_query.py list-tags;python skills/swagger-api-query/scripts/swagger_query.py search "login";python skills/swagger-api-query/scripts/swagger_query.py detail "/api/auth/login" post;python skills/swagger-api-query/scripts/swagger_query.py schema "UserDTO"。

限制:detail 对含多个方法的路径需显式指定方法(get/post 等);路径、标签或关键词含空格时需加引号;脚本会返回文件未找到、JSON 解析失败、路径或 Schema 未找到等错误信息。其他收费、平台与效果信息暂未提供。