src.app

The main web application that serves the Digital Twin to the web through a Rest API.

Attributes

app
SWAGGER_URL
API_URL
swagger_ui_blueprint
gunicorn_logger

Functions

index(→ flask.Response)	Ping this endpoint to check that the flask app is running.
health_check(→ flask.Response)	Ping this endpoint to check that the server is up and running.

Module Contents

src.app.app

src.app.SWAGGER_URL = '/swagger'

src.app.API_URL = '/static/api_documentation.yml'

src.app.swagger_ui_blueprint

src.app.index() → flask.Response

Ping this endpoint to check that the flask app is running. Supported methods: GET

Returns:

The HTTP Response. Expect OK if health check is successful

Return type:

Response

src.app.health_check() → flask.Response

Ping this endpoint to check that the server is up and running. Supported methods: GET

Returns:

The HTTP Response. Expect OK if health check is successful

Return type:

Response

src.app.gunicorn_logger