用途
Apifox Skill 提供 ABC 医疗云 API 文档查询功能,用于读取和查询 ABC API 的 OpenAPI 规范文档,帮助用户快速定位接口定义、搜索功能接口、导出文档摘要以及查看接口统计信息。
主要能力
- 接口查询:支持按模块、路径、方法搜索接口,可获取单个接口详情并自动解析 $ref 引用。
- 模块管理:列出所有模块及接口统计,支持按模块过滤接口路径。
- 数据分析:显示接口总数、模块分布等统计信息,支持导出接口摘要为 JSON 或 Markdown 格式。
- 缓存管理:首次从 Apifox API 获取 OpenAPI 文档后缓存到本地,缓存永久有效,支持手动刷新和清除缓存。
ABC 医疗云 API 文档包含以下模块:api(2506 个 HTTP API 接口)、rpc(1338 个 RPC 服务接口)、api-weapp(294 个小程序 API 接口)、api-device(29 个设备接口)、api-mp(17 个公众号接口)、api-external(14 个外部接口)。
使用方式
环境配置
使用前需要配置 Apifox Access Token:
export APIFOX_ACCESS_TOKEN="你的 Apifox Access Token"
export APIFOX_PROJECT_ID="4105462"
获取 Access Token 的步骤:登录 Apifox,进入账号设置 > API 访问令牌,创建新的访问令牌,复制 Token 并配置到环境变量。
依赖安装
pip3 install requests
命令调用
所有命令通过统一入口脚本调用:
./scripts/apifox <command> [参数]
./scripts/apifox 是 shell wrapper,会自动检测并使用系统中可用的 Python 解释器(python3 或 python)。所有命令默认返回 JSON 格式输出。
常用命令
read_oas:读取完整 OpenAPI 规范(约 5MB JSON)refresh_oas:刷新/更新最新文档cache_status:查看缓存状态和版本clear_cache:清除本地缓存(需要 --force 参数)list_paths:列出接口路径(支持模块和方法过滤)search_paths:搜索接口(关键词匹配)get_path:获取单个接口详情(自动解析 $ref)list_modules:列出所有模块及接口统计stats:显示统计信息(接口总数、模块分布)export_summary:导出接口摘要(JSON/Markdown)
使用示例
查询接口详情:
./scripts/apifox get_path \
--path "/api/global-auth/login/sms" \
--method POST
搜索接口:
./scripts/apifox search_paths --keyword "login"
./scripts/apifox search_paths --keyword "user" --module api
./scripts/apifox list_paths --method post --limit 20
模块查询:
./scripts/apifox list_modules
./scripts/apifox list_paths --module api-weapp --limit 20
统计信息:
./scripts/apifox stats
./scripts/apifox stats --detail
缓存管理:
./scripts/apifox cache_status
./scripts/apifox refresh_oas
./scripts/apifox clear_cache --force
导出摘要:
./scripts/apifox export_summary --module api --output api_summary.md --format markdown
./scripts/apifox export_summary --output full_summary.json --format json
适用场景
- 查询 API 接口定义
- 搜索特定功能接口
- 导出接口文档摘要
- 查看接口统计信息
- 在 Claude 中通过 Bash 工具调用脚本,辅助 API 文档查询工作流
限制
- 使用前必须配置 Apifox Access Token 环境变量,否则无法获取文档。
- 依赖 Python requests 库,需提前安装。
- 缓存永久有效,需要手动刷新才能获取最新文档。
- 首次使用或手动刷新时需通过 HTTP 请求从 Apifox API 获取数据,后续使用从本地缓存加载。
- 搜索性能基于内存索引,毫秒级响应。
- 所有命令默认返回 JSON 格式输出,成功时返回
{"success": true, "data": "返回的数据"},错误时返回{"success": false, "error": "错误信息"}。