potitoaghilar / easydoc-openapi-v3

Project Documentation

This will be populated by prepare-docs script

Global dependency

Install widdershins npm package globally in WSL:

$ npm i -g widdershins

Workflow

Change swagger.json endpoint

Edit swagger.json endpoint in package.json:

"prepare-docs": "bash -l -c 'SWAGGER_ENDPOINT=<swagger-json-endpoint> ./prepare-docs.sh'"

Populate documentation

To run the prepare-docs script:

$ yarn run prepare-docs

Start development server

To run the docs:dev script:

$ yarn run docs:dev

Build documentation

To run the docs:build script:

$ yarn run docs:build