Skip to content

app

Utils for getting a fastapi proxy app.

The high-level API for fastapi_proxy_lib.fastapi.router.

forward_http_app(client=None, *, follow_redirects=False, proxy_filter=None)

Fastapi app factory for forward http proxy.

Examples:

The same as ForwardHttpProxy.__init__.

Parameters:

Name Type Description Default
client Optional[AsyncClient]

refer to ForwardHttpProxy.

 None
follow_redirects bool

refer to ForwardHttpProxy.

 False
proxy_filter Optional[ProxyFilterProto]

refer to ForwardHttpProxy.

 None
Source code in src/fastapi_proxy_lib/fastapi/app.py 
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
def forward_http_app(
    client: Optional[httpx.AsyncClient] = None,
    *,
    follow_redirects: bool = False,
    proxy_filter: Optional[ProxyFilterProto] = None,
) -> FastAPI:
    """Fastapi app factory for forward http proxy.

    Examples:
        The same as [`ForwardHttpProxy.__init__`][fastapi_proxy_lib.core.http.ForwardHttpProxy.__init__].

    Args:
        client: refer to [`ForwardHttpProxy`][fastapi_proxy_lib.core.http.ForwardHttpProxy].
        follow_redirects: refer to [`ForwardHttpProxy`][fastapi_proxy_lib.core.http.ForwardHttpProxy].
        proxy_filter: refer to [`ForwardHttpProxy`][fastapi_proxy_lib.core.http.ForwardHttpProxy].
    """
    forward_http_proxy = ForwardHttpProxy(
        client, proxy_filter=proxy_filter, follow_redirects=follow_redirects
    )

    return _proxy2app(forward_http_proxy)

reverse_http_app(client=None, *, base_url, follow_redirects=False)

Fastapi app factory for reverse http proxy.

Examples:

The same as ReverseHttpProxy.__init__.

Parameters:

Name Type Description Default
client Optional[AsyncClient]

refer to ReverseHttpProxy.

 None
base_url Union[URL, str]

refer to ReverseHttpProxy.

 required
follow_redirects bool

refer to ReverseHttpProxy.

 False
Source code in src/fastapi_proxy_lib/fastapi/app.py 
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
def reverse_http_app(
    client: Optional[httpx.AsyncClient] = None,
    *,
    base_url: Union[httpx.URL, str],
    follow_redirects: bool = False,
) -> FastAPI:
    """Fastapi app factory for reverse http proxy.

    Examples:
        The same as [`ReverseHttpProxy.__init__`][fastapi_proxy_lib.core.http.ReverseHttpProxy.__init__].

    Args:
        client: refer to [`ReverseHttpProxy`][fastapi_proxy_lib.core.http.ReverseHttpProxy].
        base_url: refer to [`ReverseHttpProxy`][fastapi_proxy_lib.core.http.ReverseHttpProxy].
        follow_redirects: refer to [`ReverseHttpProxy`][fastapi_proxy_lib.core.http.ReverseHttpProxy].
    """
    reverse_http_proxy = ReverseHttpProxy(
        client,
        base_url=base_url,
        follow_redirects=follow_redirects,
    )

    return _proxy2app(reverse_http_proxy)

reverse_ws_app(client=None, *, base_url, follow_redirects=False, max_message_size_bytes=DEFAULT_MAX_MESSAGE_SIZE_BYTES, queue_size=DEFAULT_QUEUE_SIZE, keepalive_ping_interval_seconds=DEFAULT_KEEPALIVE_PING_INTERVAL_SECONDS, keepalive_ping_timeout_seconds=DEFAULT_KEEPALIVE_PING_TIMEOUT_SECONDS)

Fastapi app factory for reverse ws proxy.

Examples:

The same as ReverseWebSocketProxy.__init__.

Parameters:

Name Type Description Default
client Optional[AsyncClient]

refer to ReverseWebSocketProxy.

 None
base_url Union[URL, str]

refer to ReverseWebSocketProxy.

 required
follow_redirects bool

refer to ReverseWebSocketProxy.

 False
max_message_size_bytes int

refer to ReverseWebSocketProxy.

 DEFAULT_MAX_MESSAGE_SIZE_BYTES
queue_size int

refer to ReverseWebSocketProxy.

 DEFAULT_QUEUE_SIZE
keepalive_ping_interval_seconds Union[float, None]

refer to ReverseWebSocketProxy.

 DEFAULT_KEEPALIVE_PING_INTERVAL_SECONDS
keepalive_ping_timeout_seconds Union[float, None]

refer to ReverseWebSocketProxy.

 DEFAULT_KEEPALIVE_PING_TIMEOUT_SECONDS
Source code in src/fastapi_proxy_lib/fastapi/app.py 
 95
 96
 97
 98
 99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
def reverse_ws_app(
    client: Optional[httpx.AsyncClient] = None,
    *,
    base_url: Union[httpx.URL, str],
    follow_redirects: bool = False,
    max_message_size_bytes: int = DEFAULT_MAX_MESSAGE_SIZE_BYTES,
    queue_size: int = DEFAULT_QUEUE_SIZE,
    keepalive_ping_interval_seconds: Union[
        float, None
    ] = DEFAULT_KEEPALIVE_PING_INTERVAL_SECONDS,
    keepalive_ping_timeout_seconds: Union[
        float, None
    ] = DEFAULT_KEEPALIVE_PING_TIMEOUT_SECONDS,
) -> FastAPI:
    """Fastapi app factory for reverse ws proxy.

    Examples:
        The same as [`ReverseWebSocketProxy.__init__`][fastapi_proxy_lib.core.websocket.ReverseWebSocketProxy.__init__].

    Args:
        client: refer to [`ReverseWebSocketProxy`][fastapi_proxy_lib.core.websocket.ReverseWebSocketProxy].
        base_url: refer to [`ReverseWebSocketProxy`][fastapi_proxy_lib.core.websocket.ReverseWebSocketProxy].
        follow_redirects: refer to [`ReverseWebSocketProxy`][fastapi_proxy_lib.core.websocket.ReverseWebSocketProxy].
        max_message_size_bytes: refer to [`ReverseWebSocketProxy`][fastapi_proxy_lib.core.websocket.ReverseWebSocketProxy].
        queue_size: refer to [`ReverseWebSocketProxy`][fastapi_proxy_lib.core.websocket.ReverseWebSocketProxy].
        keepalive_ping_interval_seconds: refer to [`ReverseWebSocketProxy`][fastapi_proxy_lib.core.websocket.ReverseWebSocketProxy].
        keepalive_ping_timeout_seconds: refer to [`ReverseWebSocketProxy`][fastapi_proxy_lib.core.websocket.ReverseWebSocketProxy].
    """
    reverse_websocket_proxy = ReverseWebSocketProxy(
        client,
        base_url=base_url,
        follow_redirects=follow_redirects,
        max_message_size_bytes=max_message_size_bytes,
        queue_size=queue_size,
        keepalive_ping_interval_seconds=keepalive_ping_interval_seconds,
        keepalive_ping_timeout_seconds=keepalive_ping_timeout_seconds,
    )

    return _proxy2app(reverse_websocket_proxy)