Add optic for documentation #479
Open
Conversation
This file contains hidden or 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
… Specification within
…nts and changes to the API
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
1 participant
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.
Solution for #355
Thanks for making a really awesome rest boilerplate, I really appreciate how useful it is to have a drag and drop starter for new APIs and apps.
I've added Optic as an alternative to apiDoc, as the middleware is non-intrusive and it allows you to capture the API endpoints as you develop the app (including changes). You can then use
api generate:oasto get an OpenAPI as part of the process. 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 tooling.