HTTP/WebSocket proxy for starlette/FastAPI
CI/CD | |
Code | |
Package | |
Meta |
Documentation: https://wsh032.github.io/fastapi-proxy-lib/
Source Code: https://github.com/WSH032/fastapi-proxy-lib/
app
/router
for proxy conveniently.Starlette
is required for it to work (FastAPI
is optional).GET
, POST
, etc.)fastapi-proxy-lib
value privacy security.fastapi-proxy-lib
has a well-designed mechanism behind the scenes to handle exceptional websocket disconnections for you.fastapi-proxy-lib
will exit as gracefully as possible.FastAPI Proxy Lib
stands on the shoulders of giantsSo, it perfectly supports all features of httpx.AsyncClient, you can even use your custom AsyncClient
, Transport
.
See Advanced Usage for more details.
except
cookies
andbase_url
arguments, which are taken over byfastapi-proxy-lib
!!! note
We follow semantic versioning.<br> This is a young project, and before 1.0.0, there may be changes in the API (we try to avoid that).<br> We will release security updates at any time, please try to keep the version updated, instead of pinning to the old version.<br> pin to `major version` is recommended.<br> visit our `CHANGELOG.md` for more info.
pip install fastapi-proxy-lib[standard]
Perhaps you've noticed that we're installing fastapi-proxy-lib[standard]
instead of fastapi-proxy-lib
. The difference is:
FastAPI
at the same time.fastapi-proxy-lib
.If you only need to use this library with Starlette, you only need to install the latter.
With the helper functions, get the FastAPI proxy server app is very convenient and out of the box:
from fastapi_proxy_lib.fastapi.app import reverse_http_app
app = reverse_http_app(base_url="http://www.example.com/foo/")
That's all! Now, you can launch the proxy server with uvicorn
:
uvicorn main:app --host 127.0.0.1 --port 8000
Then, visit http://127.0.0.1:8000/bar?baz=1
, you will get the response from http://www.example.com/foo/bar?baz=1
.
Continue, please visit to our documentation 📚 for more details:
FastAPI router
Starlette
dependencyWebSocket
proxyCONTRIBUTING.md
, PR Welcome!English is not the native language of the author (me), so if you find any areas for improvement in the documentation, your feedback is welcome.
If you think this project helpful, consider giving it a star , which makes me happy. :smile:
Can fastapi proxy another site as a response to the request?
This project is licensed under the terms of the Apache License 2.0.