abc-apifox_skill

Overview

This skill lets you query the ABC Medical Cloud OpenAPI documentation (5,000+ endpoints) locally and quickly. It reads and caches the Apifox-exported OpenAPI specs, resolves $ref references, and supports fast searches by module, path, and HTTP method. The cache is split by module and schema groups for low-latency lookups.

How this skill works

On first run the skill fetches the OpenAPI specs from Apifox using an access token and builds a persistent, module-split cache. Queries load only relevant module or schema files, auto-resolve $ref pointers on demand, and return JSON results. Commands exist to search paths, retrieve endpoint details, fetch schema definitions, list modules, and manage/refresh the cache.

When to use it

• Explore or confirm API endpoint definitions before coding or testing
• Search for endpoints by keyword, path pattern, module, or HTTP method
• Inspect and resolve Schema definitions referenced by endpoints
• Get module-level API lists and simple usage statistics
• Refresh or clear cached API docs when upstream OpenAPI changes

Best practices

• Initialize the cache once after setting APIFOX_ACCESS_TOKEN and optional APIFOX_PROJECT_ID
• Always run search_paths before get_path to confirm the endpoint exists
• Use module filtering for narrow, faster searches when you know the module name
• Include --include_refs true when you need complete request/response schemas
• Refresh the cache after upstream API changes and run test_apifox.py after code edits

Example use cases

• Search for inventory-related endpoints: search_paths --keyword "stock" --module api.stocks
• Get full endpoint details including resolved refs: get_path --path "/api/v3/goods/stocks/check/orders" --method POST --include_refs true
• Fetch a Schema by name to inspect fields: get_schema --name CreateGoodsStockCheckOrderReq
• List all modules to discover surface area: list_modules then get_module --module api.stocks
• Automate CI check that cache is fresh: refresh_oas followed by test_apifox.py