Updated docs for path-params#1521
Merged
Merged
Conversation
Codecov Report
@@ Coverage Diff @@
## master #1521 +/- ##
==========================================
Coverage 100.00% 100.00%
==========================================
Files 227 234 +7
Lines 6810 6986 +176
==========================================
+ Hits 6810 6986 +176
Continue to review full report at Codecov.
|
Member
|
Cool, thanks! 🍰 📝 |
Kludex
reviewed
Jun 13, 2020
| And because the generated schema is from the <a href="https://github.com/OAI/OpenAPI-Specification/blob/master/versions/3.0.2.md" class="external-link" target="_blank">OpenAPI</a> standard, there are many compatible tools. | ||
|
|
||
| Because of this, **FastAPI** itself provides an alternative API documentation (using ReDoc): | ||
| Because of this, **FastAPI** itself provides an alternative API documentation (using ReDoc), which you can access at <a href="http://127.0.0.1:8000/redoc" class="external-link" target="_blank">http://127.0.0.1:8000/redoc</a>: |
Member
There was a problem hiding this comment.
I'm not sure that we can assume the existence of this URL.
Member
There was a problem hiding this comment.
Yeah, I was thinking that, but the example right above for Swagger UI assumes it's running (from the previous examples), so I guess it makes sense to have the link here too.
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
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.
tutorial005for readability.