Thanks to visit codestin.com
Credit goes to github.com

Skip to content

Updated docs for path-params#1521

Merged
tiangolo merged 4 commits into
fastapi:masterfrom
yankeexe:path-params-updates
Jun 13, 2020
Merged

Updated docs for path-params#1521
tiangolo merged 4 commits into
fastapi:masterfrom
yankeexe:path-params-updates

Conversation

@yankeexe

@yankeexe yankeexe commented Jun 5, 2020

Copy link
Copy Markdown
Contributor
  • Added example response for enum section.
  • Added URL's for
  • Redoc in localhost
  • Starlett
  • Added line breaks in tutorial005 for readability.

@codecov

codecov Bot commented Jun 5, 2020

Copy link
Copy Markdown

Codecov Report

Merging #1521 into master will not change coverage.
The diff coverage is n/a.

Impacted file tree graph

@@            Coverage Diff             @@
##            master     #1521    +/-   ##
==========================================
  Coverage   100.00%   100.00%            
==========================================
  Files          227       234     +7     
  Lines         6810      6986   +176     
==========================================
+ Hits          6810      6986   +176     
Impacted Files Coverage Δ
fastapi/params.py 100.00% <0.00%> (ø)
fastapi/routing.py 100.00% <0.00%> (ø)
fastapi/applications.py 100.00% <0.00%> (ø)
fastapi/openapi/docs.py 100.00% <0.00%> (ø)
fastapi/openapi/utils.py 100.00% <0.00%> (ø)
fastapi/security/__init__.py 100.00% <0.00%> (ø)
fastapi/dependencies/utils.py 100.00% <0.00%> (ø)
tests/test_security_oauth2.py 100.00% <0.00%> (ø)
tests/test_dependency_class.py 100.00% <0.00%> (ø)
tests/test_security_oauth2_optional.py 100.00% <0.00%> (ø)
... and 8 more

Continue to review full report at Codecov.

Legend - Click here to learn more
Δ = absolute <relative> (impact), ø = not affected, ? = missing data
Powered by Codecov. Last update a0e4d38...4e613ce. Read the comment docs.

@tiangolo tiangolo merged commit 748bedd into fastapi:master Jun 13, 2020
@tiangolo

Copy link
Copy Markdown
Member

Cool, thanks! 🍰 📝

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>:

Copy link
Copy Markdown
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I'm not sure that we can assume the existence of this URL.

Copy link
Copy Markdown
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

it was already merged, nvm

Copy link
Copy Markdown
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

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.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

3 participants