1.1.2 • Published 2 years ago
@bgcbrasil/swagger-ui-formatter v1.1.2
@bgcbrasil/swagger-ui-formatter
What is this repository for?
- Quick summary
- Simple CLI library responsible to transform a Swagger specification file into BGC's format
- Version
- 1.0.0
How do I get set up?
- To set up you must run
npm installto fetch dependencies; - This repository is commitizen friendly, so if you wanna use it you must install package globally
npm install -g commitizen
How to use it
- You should be able to run the CLI with:
npx @bgcbrasil/swagger-ui-formatter <command> <options>
- Commands:
- format
| Option | Type | Required | Default value | Description |
|---|---|---|---|---|
| –documentationPath | String | true | - | Relative path where we can find the default Swagger JSON documentation definition |
| –defaultTag | String | false | “public” | Default Swagger tag added to endpoints |
| –outputPrefix | String | false | “documentation” | Default prefix added to generated files, ex.: “documentation” prefix will generate documentation.json and documentation_external.json files |
| –setAuthorization | Boolean | false | true | If true will set BGC Authorization on Swagger authorizers |
| –deleteOptionMethods | Boolean | false | true | If true will remove all option methods |
1.1.1
2 years ago
1.1.0-dev.2
2 years ago
1.1.0
2 years ago
1.1.0-dev.1
2 years ago
1.1.1-dev.1
2 years ago
1.1.2
2 years ago
1.0.3
2 years ago
1.0.2
2 years ago
1.0.1
2 years ago
1.0.0
2 years ago