Add Swagger API documentation #395
Merged
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
alexwaibel
added
help wanted
eduardoboucas
approved these changes
Nov 22, 2020
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in 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.
This PR adds automatically generated swagger api docs at the new
/api-docsendpoint. We can write the documentation in the jsdoc comments for each route so the documentation lives close to the actual code and is unlikely to be forgotten when updating the API. These jsdoc annotations are used to generate an interactive API doc with support for things like example request and responses, and an interactive REST client to try out requests.I haven't gotten everything fully documented yet, but it's a start. Some of the endpoints could use some example requests and responses. I've marked all non-v3 endpoints as deprecated in an attempt to make it more clear that users should use the new v3 endpoints.
Somewhat related to #367 and #312