Skip to content
New issue

Have a question about this project?Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to ourterms of serviceand privacy statement.We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Jump to bottom

Add Open API prefix route - correct docs behind reverse proxy #26

Merged
merged 11 commits into from
Feb 14, 2019
Merged

Add Open API prefix route - correct docs behind reverse proxy #26

merged 11 commits into from
Feb 14, 2019
+191 −4

Conversation

kabirkhan
Copy link
Contributor

I run a lot of services in Kubernetes usingAmbassadoras my API Gateway. Ambassador allows you to configure a route prefix for each one of your services and then it handles ingress and routing to the initial service. This PR enables me to configure the same prefix I use with Ambassador in the Swagger UI API docs.

Example:

prefix='/service1'

app=FastAPI(
openapi_prefix=prefix
)
@app.get('/something')=>SwaggerRoute(GET-/service1/something)

NOTE: This is not the same as using the include_router method and adding a prefix.
This is meant only to rewrite the route paths in the Swagger UI.

BTW: Awesome Project! Thanks so much for your work on this, I'm using fastapi a ton these days.

@codecov
Copy link

codecov bot commented Feb 10, 2019 •
edited
Loading

CodecovReport

Merging#26intomasterwillnot changecoverage.
The diff coverage is100%.

Impacted file tree graph

@@ Coverage Diff @@
## master #26 +/- ##
=====================================
Coverage 100% 100%
=====================================
Files 95 99 +4
Lines 2484 2582 +98
=====================================
+Hits 2484 2582 +98
Impacted Files Coverage Δ
fastapi/openapi/utils.py 100% <100%> (ø) ⬆️
...tutorial/test_sub_applications/test_tutorial001.py 100% <100%> (ø)
fastapi/applications.py 100% <100%> (ø) ⬆️
docs/src/sub_applications/tutorial001.py 100% <100%> (ø)
tests/test_jsonable_encoder.py 100% <0%> (ø) ⬆️
fastapi/encoders.py 100% <0%> (ø) ⬆️
tests/test_datetime.py
docs/src/sql_databases/tutorial001.py 100% <0%> (ø)
tests/test_datetime_custom_encoder.py 100% <0%> (ø)
... and2 more

Continue to review full report at Codecov.

Legend-Click here to learn more
Δ = absolute <relative> (impact),ø = not affected,?= missing data
Powered byCodecov.Last update92c825b...6f7c4cd.Read thecomment docs.

@kabirkhan kabirkhan changed the title Add Open API prefix route Add Open API prefix route - correct docs behind reverse proxy Feb 10, 2019
@kabirkhan
Copy link
Contributor Author

Fix for#15

@kabirkhan
Copy link
Contributor Author

@tiangolowould you mind taking a look at this?
I'm happy to add documentation once you review the approach.
I'd love to use the official pypi package rather than my own Github version for a production service at work.
Thanks

@tiangolo tiangolo merged commit0ea0d0e into fastapi:master Feb 14, 2019
@tiangolo
Copy link
Member

Great job@kabirkhan!Thanks a lot. 🎉 🌮

I added tests and docs on top of your work.

for a production service at work

Are you using it at MS? That's very cool!

tiangolo added a commit that referenced this pull request Feb 14, 2019
@tiangolo
🔖 Release 0.4.0 with openapi_prefix,#26
acbcbba
@tiangolo
Copy link
Member

I just released0.4.0including this PR. You should be able to use it now. 🚀

Also, the relevant docs are here:https://fastapi.tiangolo /tutorial/sub-applications-proxy/

This was referencedFeb 14, 2019
Closed
Closed
@kabirkhan
Copy link
Contributor Author

@tiangoloyep I'm actually planning to use it for all of my team's ML services at Microsoft. Some of them are getting integrated into the core Windows product and some Office products.

Great job with the documentation too!

@tiangolo
Copy link
Member

That's awesome! 🌮 🍰 🚀

May I quote it (that you at MS are using FastAPI)?

@kabirkhan
Copy link
Contributor Author

Yeah, go for it!

@sm-Fifteen
Copy link
Contributor

I know this is an old issue/PR, but shouldn'troot_pathbe used instead of adding a custom parameter to the application?root_pathis already the intended mechanism for routing under a mounted subapplication and what Uvicorn and the ASGI spec in general uses to tell the root application what its URL prefix is (it is ignored when routing, but must be taken into account when reconstructing URLs). FastAPIcurrently does not acknowledgeroot_pathin its API documentation,onlyopenapi_prefix,which means the routes specified by the API doc and the ones that are actually understood by the application will not match unless the value ofroot_pathis also passed asopenapi_prefixwhen creating the FastAPI application.

@luckydonald
Copy link

Huh, sounds about right.@sm-Fifteenyou may open a new issue for that.

@sm-Fifteen sm-Fifteen mentioned this pull request Jan 6, 2020
Closed
@tiangolo
Copy link
Member

Yeap@sm-Fifteen,I just merged#1199addressingroot_path🚀

@jkoech
Copy link

jkoech commented Jul 11, 2022

@tiangoloseems the link to theprefix route docsis broken. Perhaps did the docs move?

I just released0.4.0including this PR. You should be able to use it now. 🚀

Also, the relevant docs are here:https://fastapi.tiangolo /tutorial/sub-applications-proxy/

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Reviewers
No reviews
Assignees
No one assigned
Labels
None yet
Projects
None yet
Milestone
No milestone
Development

Successfully merging this pull request may close these issues.

None yet
5 participants
@kabirkhan @tiangolo @sm-Fifteen @luckydonald @jkoech