Enrich your OpenAPI 3.0 schema with examples
Thanks to the wonderful swagger-snippet module you can now simply enrich your OpenAPI schema with code samples. It's as easy as 1.2.3.
- Clone this repo
node index.js your_oas.json
Clone this repo
git clone https://github.com/cdwv/oas3-api-snippet-enricher
Install NPM packages
Enrich your OAS 3.0 Schema!
node index.js openapi.json > openapi-with-examples.json
Alternatively you can point it to a YAML-formatted spec:
curl https://raw.githubusercontent.com/OAI/OpenAPI-Specification/master/examples/v3.0/petstore.yaml --output petstore.yaml node index.js petstore.yaml > openapi-with-examples.json
Use ReDoc to build beautiful API doc:
redoc-cli bundle openapi-with-examples.json
Contributions are most welcome!
Project is currently maintained, in our spare time, by codewave.eu and a growing number of Contributors!