connexion.cli

This module defines a command-line interface (CLI) that runs an OpenAPI specification to be a starting point for developing your API with Connexion.

Module Contents

Functions

validate_server_requirements(ctx, param, value)

print_version(ctx, param, value)

main()

run(spec_file, base_module_path, port, host, wsgi_server, server, stub, mock, hide_spec, hide_console_ui, console_ui_url, console_ui_from, auth_all_paths, validate_responses, strict_validation, debug, verbose, base_path, app_framework)

Runs a server compliant with a OpenAPI/Swagger 2.0 Specification file.

Attributes

logger

CONTEXT_SETTINGS

FLASK_APP

AVAILABLE_SERVERS

AVAILABLE_APPS

DEFAULT_SERVERS

connexion.cli.logger
connexion.cli.CONTEXT_SETTINGS
connexion.cli.FLASK_APP = flask
connexion.cli.AVAILABLE_SERVERS
connexion.cli.AVAILABLE_APPS
connexion.cli.DEFAULT_SERVERS
connexion.cli.validate_server_requirements(ctx, param, value)
connexion.cli.print_version(ctx, param, value)
connexion.cli.main()
connexion.cli.run(spec_file, base_module_path, port, host, wsgi_server, server, stub, mock, hide_spec, hide_console_ui, console_ui_url, console_ui_from, auth_all_paths, validate_responses, strict_validation, debug, verbose, base_path, app_framework)

Runs a server compliant with a OpenAPI/Swagger 2.0 Specification file.

Arguments:

  • SPEC_FILE: specification file that describes the server endpoints.

  • BASE_MODULE_PATH (optional): filesystem path where the API endpoints handlers are going to be imported from.