mirror of
https://github.com/LukeHagar/connexion.git
synced 2025-12-06 12:27:45 +00:00
3e64fe46e9
Starlette introduced some new changes to how the `root_path` is handled, which broke our `ReverseProxied` example and test. This PR fixes both and adds documentation on how to run behind a proxy.
148 lines
4.1 KiB
ReStructuredText
148 lines
4.1 KiB
ReStructuredText
Connexion Cookbook
|
|
==================
|
|
|
|
This page provides recipes with Connexion as an ingredient.
|
|
|
|
CORS
|
|
----
|
|
|
|
You can enable CORS (Cross-origin resource sharing) by leveraging the `CORSMiddleware`_ offered by
|
|
Starlette. You can add it to your application, ideally in front of the ``RoutingMiddleware``.
|
|
|
|
|
|
.. tab-set::
|
|
|
|
.. tab-item:: AsyncApp
|
|
:sync: AsyncApp
|
|
|
|
.. code-block:: python
|
|
|
|
from pathlib import Path
|
|
|
|
from connexion import AsyncApp
|
|
from connexion.middleware import MiddlewarePosition
|
|
from starlette.middleware.cors import CORSMiddleware
|
|
|
|
|
|
app = AsyncApp(__name__)
|
|
|
|
app.add_middleware(
|
|
CORSMiddleware,
|
|
position=MiddlewarePosition.BEFORE_EXCEPTION,
|
|
allow_origins=["*"],
|
|
allow_credentials=True,
|
|
allow_methods=["*"],
|
|
allow_headers=["*"],
|
|
)
|
|
|
|
app.add_api("openapi.yaml")
|
|
|
|
if __name__ == "__main__":
|
|
app.run(f"{Path(__file__).stem}:app", port=8080)
|
|
|
|
.. dropdown:: View a detailed reference of the ``add_middleware`` method
|
|
:icon: eye
|
|
|
|
.. automethod:: connexion.AsyncApp.add_middleware
|
|
:noindex:
|
|
|
|
.. tab-item:: FlaskApp
|
|
:sync: FlaskApp
|
|
|
|
.. code-block:: python
|
|
|
|
from pathlib import Path
|
|
|
|
from connexion import FlaskApp
|
|
from connexion.middleware import MiddlewarePosition
|
|
from starlette.middleware.cors import CORSMiddleware
|
|
|
|
|
|
app = FlaskApp(__name__)
|
|
|
|
app.add_middleware(
|
|
CORSMiddleware,
|
|
position=MiddlewarePosition.BEFORE_EXCEPTION,
|
|
allow_origins=["*"],
|
|
allow_credentials=True,
|
|
allow_methods=["*"],
|
|
allow_headers=["*"],
|
|
)
|
|
|
|
app.add_api("openapi.yaml")
|
|
|
|
if __name__ == "__main__":
|
|
app.run(f"{Path(__file__).stem}:app", port=8080)
|
|
|
|
.. dropdown:: View a detailed reference of the ``add_middleware`` method
|
|
:icon: eye
|
|
|
|
.. automethod:: connexion.FlaskApp.add_middleware
|
|
:noindex:
|
|
|
|
.. tab-item:: ConnexionMiddleware
|
|
:sync: ConnexionMiddleware
|
|
|
|
.. code-block:: python
|
|
|
|
from pathlib import Path
|
|
|
|
from asgi_framework import App
|
|
from connexion import ConnexionMiddleware
|
|
from starlette.middleware.cors import CORSMiddleware
|
|
|
|
app = App(__name__)
|
|
app = ConnexionMiddleware(app)
|
|
|
|
app.add_middleware(
|
|
CORSMiddleware,
|
|
position=MiddlewarePosition.BEFORE_EXCEPTION,
|
|
allow_origins=["*"],
|
|
allow_credentials=True,
|
|
allow_methods=["*"],
|
|
allow_headers=["*"],
|
|
)
|
|
|
|
app.add_api("openapi.yaml")
|
|
|
|
if __name__ == "__main__":
|
|
app.run(f"{Path(__file__).stem}:app", port=8080)
|
|
|
|
|
|
.. dropdown:: View a detailed reference of the ``add_middleware`` method
|
|
:icon: eye
|
|
|
|
.. automethod:: connexion.ConnexionMiddleware.add_middleware
|
|
:noindex:
|
|
|
|
.. _CORSMiddleware: https://www.starlette.io/middleware/#corsmiddleware
|
|
|
|
Reverse Proxy
|
|
-------------
|
|
|
|
When running behind a reverse proxy with stripped path prefix, you need to configure your
|
|
application to properly handle this.
|
|
|
|
Single known path prefix
|
|
''''''''''''''''''''''''
|
|
|
|
If there is only a single known prefix your application will be running behind, you can simply
|
|
pass this path prefix as the `root_path` to your ASGI server:
|
|
|
|
.. code-block:: bash
|
|
|
|
$ uvicorn run:app --root-path <root_path>
|
|
|
|
.. code-block:: bash
|
|
|
|
$ gunicorn -k uvicorn.workers.UvicornWorker run:app --root-path <root_path>
|
|
|
|
|
|
Dynamic path prefix
|
|
'''''''''''''''''''
|
|
|
|
If you are running behind multiple proxies, or the path is not known, you can wrap your
|
|
application in a `ReverseProxied` middleware as shown in `this example`_.
|
|
|
|
.. _this example: https://github.com/spec-first/connexion/tree/main/examples/reverseproxy
|