express-mongoose-es6-rest-api Adding Automated Documentation via Optic

Adding Automated Documentation via Optic

Open trulyronak opened this issue 5 years ago • 2 comments

Hi @kunalkapadia!

I really appreciated this boilerplate you built - JWT is often implemented really confusingly but your implementation made it super straightforward and nice.

I've been contributing to the Optic Project and helped write integration guides on how you can use it on various API frameworks in the past, and wanted to go a step further by PR-ing my work into awesome boilerplates. When I started using this boilerplate, I added Optic early on, and thought it'd be really useful to contribute back and add auto docs to the project.

Did I implement this correctly? Would love to add this feature!

Key Changes

added 4 new scripts to package.json
- npm run api-install installs the Optic Client
- npm run api-diff runs your API with the Optic proxy, and monitors changes to the api (this lets you document changes you might have made, updating the documentation without having to manually write OpenAPI specifications)
- npm run api-docs opens up the current documentation for the api
- npm run generate-openapi generates a OpenAPI spec for the user to use
Modified config/config.js to look for the OPTIC_API_PORT (this enables optic to run) - this won't stop you from running the api like normal via npm start)