ABC Apifox Skill

This skill provides ABC Medical Cloud API document query functionality.

Environment Configuration

Required Environment Variables

Before use, you need to configure the Apifox Access Token:

bash

# 设置 Apifox Access Token（必需）
export APIFOX_ACCESS_TOKEN="你的 Apifox Access Token"

# 设置项目 ID（可选，默认为 4105462）
export APIFOX_PROJECT_ID="4105462"

Obtain Apifox Access Token

Log in to Apifox
Go to Account Settings > API Access Token
Create a new access token
Copy the Token and configure it in the environment variable

Dependency Installation

bash

# 安装 Python 依赖
pip3 install requests

Working Principle

Cache Architecture: Module-split Cache Structure

First Use: Retrieve OpenAPI documents from Apifox API
Intelligent Splitting:
- Interfaces are split by module (api.stocks, rpc.advice, etc.)
- Schemas are grouped by initial letter (A-Z + non-letters)
On-demand Loading: Only load relevant module files during queries
Persistent Cache: The cache is permanently valid, and manual refresh is required to get the latest documents

Usage

bash

./scripts/apifox <command> [参数]

All commands return JSON format output by default.

Command List

Interface Query

Command	Description
`get_path`	Get interface details (automatically infers module)
`get_schema`	Get Schema definitions
`search_paths`	Search interfaces (keyword matching)
`list_modules`	List all modules
`get_module`	Get all interfaces of a module

Document Management

Command	Description
`refresh_oas`	Refresh OpenAPI documents
`status`	View cache status
`clear_cache`	Clear local cache (requires `--force` )

Usage Examples

Get Interface Details

bash

# 获取接口详情（自动推断模块）
./scripts/apifox get_path \
    --path "/api/v3/goods/stocks/check/orders" \
    --method POST

# 获取接口并解析 $ref 引用
./scripts/apifox get_path \
    --path "/api/v3/goods/stocks/check/orders" \
    --method POST \
    --include_refs true

Get Schema Definitions

bash

# 获取 Schema 定义
./scripts/apifox get_schema --name CreateGoodsStockCheckOrderReq

Search Interfaces

bash

# 搜索盘点相关接口
./scripts/apifox search_paths --keyword "盘点"

# 搜索特定模块的接口
./scripts/apifox search_paths --keyword "库存" --module api.stocks

# 按方法过滤
./scripts/apifox search_paths --keyword "order" --method POST --limit 10

Module Query

bash

# 列出所有模块
./scripts/apifox list_modules

# 获取特定模块的所有接口
./scripts/apifox get_module --module api.stocks

Document Management

bash

# 查看缓存状态
./scripts/apifox status

# 刷新文档（从 Apifox 获取最新数据）
./scripts/apifox refresh_oas

# 清除缓存
./scripts/apifox clear_cache --force

Output Format

All commands return JSON format:

json

{
  "success": true,
  "data": "返回的数据"
}

Returns on error:

json

{
  "success": false,
  "error": "错误信息"
}

Usage with Claude

When users need to query API documents:

Understand Requirements: Determine the interface or Schema to query
Build Command: Select the appropriate command based on requirements
Execute Script: Run using Bash tools
Analyze Results: Parse the returned interface/Schema definitions

Example Workflow:

User: "View the definition of the inventory check interface"

Claude:
1. ./scripts/apifox search_paths --keyword "盘点"
2. Find the relevant interface path from the results
3. ./scripts/apifox get_path --path "/api/v3/goods/stocks/check/orders" --method POST
4. Analyze the returned request body CreateGoodsStockCheckOrderReq
5. If Schema viewing is needed: ./scripts/apifox get_schema --name CreateGoodsStockCheckOrderReq

Cache Structure

cache/
├── meta.json              # 元数据 + 全局索引
├── modules/               # 按模块拆分的接口数据
│   ├── api.stocks.json    # 库存相关接口
│   ├── rpc.advice.json    # 医嘱相关接口
│   └── ...
└── schemas/               # Schema 定义缓存（按首字母分组）
    ├── a.json             # A 开头的 Schema
    ├── b.json
    ├── ...
    └── _.json             # 非字母开头的 Schema（中文、数字等）

Module Naming Rules

Path Format	Module Name	Example
`/api/v3/goods/stocks/xxx`	`api.stocks`	Inventory Module
`/rpc/advice/xxx`	`rpc.advice`	Medical Advice Module
`/api/global-auth/xxx`	`api.global-auth`	Authentication Module

File Structure

scripts/
├── apifox              # 命令行工具入口
├── apifox.py           # Python CLI 实现
├── apifox_client.py    # 客户端
├── cache_manager.py    # 缓存管理器
├── requirements.txt    # Python 依赖
├── check_env.py        # 环境检查脚本
└── test_apifox.py      # 功能测试脚本

First Use

bash

# 配置环境变量后首次运行
./scripts/apifox status

# 自动从 Apifox 获取文档并建立缓存
# 正在从 Apifox 获取项目 4105462 的 OpenAPI 文档...
# 正在清空旧缓存...
# 正在按模块拆分接口...
# 正在保存 Schema（分组格式）...
# 导入完成!

Development Tools

Environment Check (

check_env.py

)

Check environment configuration and API connection status:

bash

python3 scripts/check_env.py

Check Items:

Whether environment variables are configured
Whether Python dependencies are installed
Cache status
API connection test

Usage Scenarios:

Verify environment after initial configuration
Diagnose when API connection is abnormal
Confirm effectiveness after modifying environment variables

Function Test (

test_apifox.py

)

Smoke test suite to verify normal core functions:

bash

python3 scripts/test_apifox.py

Test Content:

Cache loading
Search performance (average should be < 100ms)
Module filtering
Method filtering
Interface details retrieval
Schema retrieval
Module list

Usage Scenarios:

Must run after modifying code to ensure normal functionality
Regression testing before deployment
Performance degradation detection

Dependency Installation (

requirements.txt

)

bash

# 安装依赖
pip3 install -r scripts/requirements.txt

Development Workflow

Smoke tests must be executed after modifying functions:

bash

# 1. 修改代码
vim scripts/cache_manager.py

# 2. 运行测试（必须）
python3 scripts/test_apifox.py

# 3. 测试通过后提交
git add scripts/cache_manager.py
git commit -m "fix: ..."

When Tests Fail:

Check if modifications have broken existing functionality
Run
```
check_env.py
```
to diagnose environment issues
Fix and retest until passed

abc-apifox

NPX Install

Tags

SKILL.md Content (Chinese)

ABC Apifox Skill

Environment Configuration

Required Environment Variables

Obtain Apifox Access Token

Dependency Installation

Working Principle

Usage

Command List

Interface Query

Document Management

Usage Examples

Get Interface Details

Get Schema Definitions

Search Interfaces

Module Query

Document Management

Output Format

Usage with Claude

Cache Structure

Module Naming Rules

File Structure

First Use

Development Tools

Environment Check (
`check_env.py`
)

Function Test (
`test_apifox.py`
)

Dependency Installation (
`requirements.txt`
)

Development Workflow

abc-apifox

NPX Install

Tags

SKILL.md Content (Chinese)

ABC Apifox Skill

Environment Configuration

Required Environment Variables

Obtain Apifox Access Token

Dependency Installation

Working Principle

Usage

Command List

Interface Query

Document Management

Usage Examples

Get Interface Details

Get Schema Definitions

Search Interfaces

Module Query

Document Management

Output Format

Usage with Claude

Cache Structure

Module Naming Rules

File Structure

First Use

Development Tools

Environment Check (check_env.py)

Function Test (test_apifox.py)

Dependency Installation (requirements.txt)

Development Workflow

Environment Check (
`check_env.py`
)

Function Test (
`test_apifox.py`
)

Dependency Installation (
`requirements.txt`
)