Add Optic for documentation #375
Open
Conversation
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
# for free
to join this conversation on GitHub.
Already have an account?
# to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
Hi @madhums,
I really like this demo, I really like how it clearly shows an interactive app that someone can use as a boilerplate for an Express app they are building. I've referenced this in the past when searching for Mongoose with Express examples.
I thought it'd be great to add Optic as a way to automate the collection of API endpoint documentation, I've gone ahead and added the middleware and the pointers in the README. I've set it to only run in non-production setups with minimal hassle and to not get in the way of the users flow if they don't want to use the CLI.
Thanks,
Mike