Quickstart

Prerequisites

Python 3.6+

Installing It

In your command line, type this:

$ pip install connexion[swagger-ui]

Running It

Put your API YAML inside a folder in the root path of your application (e.g openapi/) and then do

import connexion

app = connexion.FlaskApp(__name__, specification_dir='openapi/')
app.add_api('my_api.yaml')
app.run(port=8080)

Dynamic Rendering of Your Specification

Connexion uses Jinja2 to allow specification parameterization through arguments parameter. You can either define specification arguments globally for the application in the connexion.App constructor, or for each specific API in the connexion.App#add_api method:

app = connexion.FlaskApp(__name__, specification_dir='openapi/',
                    arguments={'global': 'global_value'})
app.add_api('my_api.yaml', arguments={'api_local': 'local_value'})
app.run(port=8080)

When a value is provided both globally and on the API, the API value will take precedence.

The Swagger UI Console

The Swagger UI for an API is available, by default, in {base_path}/ui/ where base_path is the base path of the API.

You can disable the Swagger UI at the application level:

options = {"swagger_ui": False}
app = connexion.FlaskApp(__name__, specification_dir='openapi/',
                    options=options)
app.add_api('my_api.yaml')

You can also disable it at the API level:

options = {"swagger_ui": False}
app = connexion.FlaskApp(__name__, specification_dir='openapi/')
app.add_api('my_api.yaml', options=options)

You can pass custom Swagger UI Configuration Parameters like e.g. displayOperationId through the swagger_ui_config option:

options = {"swagger_ui_config": {"displayOperationId": True}}
app = connexion.FlaskApp(__name__, specification_dir='openapi/',
                    options=options)

Server Backend

By default connexion uses the default flask server but you can also use Tornado or gevent as the HTTP server, to do so set server to tornado or gevent:

import connexion

app = connexion.FlaskApp(__name__, port = 8080, specification_dir='openapi/', server='tornado')

Additionally, you can pass the parameters for the corresponding server as a dictionary using the server_args parameter. For example, in a scenario where you’re serving static content, you can pass the parameters as follows:

import connexion

app = connexion.FlaskApp(
    __name__,
    port=8080,
    specification_dir='openapi/',
    server='flask',
    server_args={'static_url_path': '/', 'static_folder': 'wherever/your/static/files/are'}
)