apifox-ptfe-gen

Generate TypeScript API files from Swagger/OpenAPI docs and Apifox shared docs.

Usage

1. Put config in your project package.json:

{
  "apifoxPtfeGen": {
    "url": "https://s.apifox.cn/<share-id>",
    "outDir": "src/Apis",
    "full": false
  }
}

apifoxPtfeGen is preferred, but the legacy swaggerPtfeGen / swagger-ptfe-gen keys are still supported for compatibility.

2. Run command:

apifox-ptfe-gen

Or override by CLI args:

apifox-ptfe-gen --url https://s.apifox.cn/<share-id> --outDir src/Apis

Supported input URLs

• Swagger / OpenAPI JSON URLs
• Swagger UI HTML pages that expose a url / urls config or /swagger.json / /v2/api-docs
• Apifox public share root URLs such as https://s.apifox.cn/<share-id>
• Apifox public share detail URLs such as https://s.apifox.cn/<share-id>/<detail-id>
• Single Apifox markdown pages such as https://s.apifox.cn/<share-id>/<detail-id>.md

Apifox support notes

• Apifox support only targets public s.apifox.cn share links.
• Share roots and detail pages expand through llms.txt, so the whole shared document set is generated.
• Direct .md URLs only generate the single API page they point to.
• The current normalization layer supports JSON request bodies plus path/query/header/cookie parameters.
• Non-JSON request bodies such as multipart/form-data are rejected with a clear error message.