| name | download-openapi |
| description | Download remote OpenAPI/Swagger JSON specification from a URL to local file using aptx-ft CLI. TRIGGER when user mentions: (1) fetch/pull/download swagger or openapi from URL, (2) save API spec to openapi.json locally, (3) get API documentation from server, or (4) prepare local input for code generation. DO NOT TRIGGER when: generating code/types from local file, reading existing openapi.json, downloading non-OpenAPI files, or authentication is required. |
Download OpenAPI JSON
Download OpenAPI 3.x JSON specification from a remote URL.
Prerequisites
pnpm add -D @aptx/frontend-tk-cli
Usage
pnpm exec aptx-ft input download --url <url> --output <file>
Alternative (without pnpm):
npx aptx-ft input download --url <url> --output <file>
Example
pnpm exec aptx-ft input download --url https://api.example.com/swagger.json --output ./openapi.json
Workflow
- Confirm the OpenAPI URL with user
- Choose output path (recommended:
./openapi.json)
- Execute download command
- Pass the file path to other skills (generate-models, generate-artifacts)
Output
- Local OpenAPI JSON file (e.g.,
./openapi.json)
Boundaries
This skill only handles OpenAPI JSON format downloads:
- Does NOT support YAML format
- Does NOT handle authenticated URLs (Bearer Token, etc.)
- Does NOT support custom request headers
- Only validates JSON syntax, not OpenAPI specification validity
For these cases, download manually and use other tools.
