FastAPI Proxy Lib

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/

Features

• [X] Out of the box ! Helper functions to get FastAPI app/router for proxy conveniently.
• [x] Only Starlette is required for it to work (FastAPI is optional).
• [x] Support both HTTP and WebSocket proxy.
  • [x] Supports all HTTP methods (GET, POST, etc.)
• [x] Support both reverse proxy and forward proxy.
• [x] Transparently and losslessly handle all proxy requests, Including HTTP headers, cookies, query parameters, body, etc.
• [x] Asynchronous streaming transfer, support file proxy.
• [x] fastapi-proxy-lib value privacy security.

other features

• [x] Strict linting and strict-mode Pyright type checking.
• [x] 100% Type Completeness, Code coverage of over 95%.
• [x] Forced keep-alive connections, minimizing proxy latency.
• [x] Handle errors as gracefully as possible.
  • 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 giants

• httpx for HTTP proxy
• httpx-ws for WebSocket proxy

So, it perfectly supports all features of httpx.AsyncClient, you can even use your custom AsyncClient, Transport.

See Advanced Usage for more details.

except cookies and base_url arguments, which are taken over by fastapi-proxy-lib

Installation

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

• The former will install FastAPI at the same time.
• The latter installs only the basic dependencies for fastapi-proxy-lib.

If you only need to use this library with Starlette, you only need to install the latter.

Quick start

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:

• support for FastAPI router
• only Starlette dependency
• WebSocket proxy

development

• If you find any issues, please don't hesitate to open an issue.
• If you need assistance, feel free to start a discussion.
• Follow our CONTRIBUTING.md, PR Welcome!
• Security 😰❗: We value any security vulnerabilities, please report to us privately, pretty appreciated for that.

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:

Refers

Can fastapi proxy another site as a response to the request?

License

This project is licensed under the terms of the Apache License 2.0.