fastapi-proxiedheadersmiddleware 0.9.0

Middleware for fastapi allowing it to respect X-Forwarded-... headers set by proxies.

HTTP Proxy Header support for FastAPI

This Python package allows transparent use of FastAPI-based solutions behind proxies which set X-Forwarded-... headers. Applications will construct URLs based on those headers rather than the incoming Host header.

Use

Install fastapi-proxiedheadersmiddleware using pip:

pip install fastapi-proxiedheadersmiddleware

The module can then be used as fastapi_proxiedheadersmiddleware when creating your FastAPI app:

from fastapi import FastAPI
from fastapi_proxiedheadersmiddleware import ProxiedHeadersMiddleware

app = FastAPI()
app.add_middleware(ProxiedHeadersMiddleware)

The middleware respects the various X-Forwarded-... headers and updates the Host header to match.

Developer quickstart

This project contains a dockerized testing environment which wraps tox.

Tests can be run using the ./test.sh command:

# Run all PyTest tests and Flake8 checks
$ ./test.sh

# Run just PyTest
$ ./test.sh -e py3

# Run a single test file within PyTest
$ ./test.sh -e py3 -- tests/test_identifiers.py

# Run a single test file within PyTest with verbose logging
$ ./test.sh -e py3 -- tests/test_identifiers.py -vvv