Skip to content
πŸ“˜ Multi-file boilerplate for Open API Specification
HTML
Branch: master
Clone or download

Latest commit

Fetching latest commit…
Cannot retrieve the latest commit at this time.

Files

Permalink
Type Name Latest commit message Commit time
Failed to load latest commit information.
_build Initial commit Feb 8, 2020
src Fixed ref Feb 8, 2020
.gitignore Initial commit Feb 8, 2020
.travis.yml Initial commit Feb 8, 2020
CONTRIBUTING.md Initial commit Feb 8, 2020
LICENSE.md Initial commit Feb 8, 2020
NOTICE.md Initial commit Feb 8, 2020
README.md Update README.md Feb 9, 2020
package-lock.json Initial commit Feb 8, 2020
package.json Initial commit Feb 8, 2020

README.md

OpenAPI boilerplate

Build Status

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

  1. 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.

You can’t perform that action at this time.