Add Swagger support #5222
Merged
Add Swagger support #5222
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
|
💬 This comment has been generated by the DeepCode bot, installed by the owner of the repository. The DeepCode bot protects your repository by detecting and commenting on security vulnerabilities or other critical issues. |
egbertbouman
force-pushed
the
swagger
branch
3 times, most recently
from
0f6e25b
to
d463f89
Compare
egbertbouman
force-pushed
the
swagger
branch
4 times, most recently
from
2718d1c
to
8c91178
Compare
|
Kudos, SonarCloud Quality Gate passed!
|
|
Is this ready for review? |
|
@qstokkink Yep, ready. |
qstokkink
approved these changes
Mar 23, 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 /docs to our REST API server that will serve the Swagger UI. From there, you will find a list of all API endpoints available in both Tribler and IPv8.
I've converted all the old doc strings to aiohttp_apispec decorators. I've also added some new documentation to a number of undocumented channels/metadata endpoints. However, since I'm not sure exactly what these functions do and what their input/output is, I've kept the documentation to a minimum. Despit this, I've probably made some mistakes here.
Swagger also supports API keys (you just need to click 'Authorize' and copy-paste the API key). The Swagger UI itself can be visited without the API key.