swagger-codegen-helper
v1.1.1
Published
help generate code from swagger(openapi) docs
Readme
Swagger Codegen Helper
中文文档
Description
Send requests to Swagger Codegen, and get API codes in return.
Prerequisites
Local Mode:
Remote Mode:
- swagger-code-server (npm)
Run
- Run
npm install - Run
npm run start - Run
npm run test:v2ornpm run test:v3
Run with npx (Recommended)
npx swagger-codegen-helper lang=typescript-fetch swaggerUrl=https://petstore3.swagger.io/api/v3/openapi.json swaggerVersion=3
npx swagger-codegen-helper lang=typescript-fetch swaggerJson=v2.json swaggerVersion=2 server=http://localhost:8787/generate-codeExplanation:
Important Parameters:
- swaggerUrl: URL to the swagger file, e.g. https://petstore3.swagger.io/api/v3/openapi.json
- swaggerJson: Path to the swagger file, e.g. ./v2.json
- swaggerVersion: Version of the swagger file, 2 or 3
- lang: Language of the generated code, e.g. typescript-fetch, javascript, python, java, etc.
- server (Remote Mode) (optional): URL to the swagger codegen server, e.g. http://localhost:8787/generate-code
Advanced
Advanced Generator Configuration
References
License
MIT
