configuration open api generator - wwwsolutions/nestjs-starter-kit GitHub Wiki

OpenAPI generator for Angular

To auto-generate models for front-end consumption. In this case by Angular.

// create a config file `openapitools.json` at root dir
{
  "$schema": "./node_modules/@openapitools/openapi-generator-cli/config.schema.json",
  "spaces": 2,
  "generator-cli": {
    "version": "5.2.0"
  }
}
// create a config file `openapiconfig.json` at root dir
{
  "serviceSuffix": "ApiService",
  "ngVersion": "12.0.0"
}

Add npm script

// add script
"rest-api-gen": "openapi-generator-cli generate -i http://localhost:3000/api/docs-json -g typescript-angular -o libs/api/rest/data-access/api/src/lib -c openapiconfig.json"

Add .eslintignore

// add exception
libs/api/rest/data-access/api/src/lib

Generator usage

// run api & execute script
npm run rest-api-gen

// code will be generated in `libs/api/rest/data-access/api/src/lib`

Check http://localhost:3000/api/v1/docs-json

Documentation version 0.0.1

⚠️ **GitHub.com Fallback** ⚠️