Connexion Auth Paths Extended

Small connexion extension to add authentication into spec routes

The connexion framework it’s possible to use an parameter called auth_all_paths (in FlaskAppand AioHttpApp), which in your docuemntation (link) is defined as:

:param auth_all_paths: whether to authenticate not defined paths
:type auth_all_paths: bool

And it can be used this way, during app initialization:

connexion_app = FlaskApp(
    __name__,
    specification_dir='.',
    auth_all_paths=True
)

But the only routes added to the authentication are the 404 Error route (link) routes, but there are other routes that should also be treated:

  • /openapi.json
  • /openapi.yaml
  • openapi_spec_path

The idea of this extension is to apply the default authentication on these routes, without changing the behavior of anything else.

Installation

Install connexion-auth-paths-extd with pip:

  pip install connexion-auth-paths-extd

Usage/Examples

from connexion.extended.auth_paths_extd import FlaskApp


def create_app():
    connexion_app = FlaskApp(
        __name__,
        specification_dir='.',
        auth_all_paths=True
    )

A better exemple is on examples folder.

GitHub

View Github