raynimmo / openapi-boilerplate

OpenAPI boilerplate

Multi-file boilerplate for Open API Specification.

Requirements

• NodeJS 12 LTS

Installation

1. Clone the repository.

git clone https://github.com/dgarcia360/openapi-boilerplate.git

2. Install the project dependencies.

npm install

Usage

Compile the OpenAPI spec from multiple files to one.

npm run build

Test if the generated OpenAPI spec is valid.

npm test

Export the OpenAPI spec to Postman.

npm run postman

Preview the OpenAPI spec by opening _build/index.yml in a new browser tab.

Contributing

Contributions are welcome and appreciated! If you want to enhance the boilerplate, please read CONTRIBUTING.md file first.

License

Copyright (c) 2019-present David Garcia (@dgarcia360).

This software includes code derived from The Linux Foundation OpenAPI-Specification examples.