change-event-service 2.0.2

Change Event Service

Change Event Service

This service is web service that provides a RESTful API for creating, deleting and querying change events.

How it Works?

This project written with Flask web framework. It use flask-smorest for REST API, Pyctuator for actuator endpoint and Flask-SQLAlchemy for handle DB queries. Swagger UI documentation and API validations handled by flask-smorest itself. flask-smorest uses Marshmallow schemas for marshalling and unmarshalling objects in request and response. This schemas also used by Swagger UI.

With Flask-APScheduler, a background job started to consume change events from the queue using Pika and persist them to the database.

Environment Variables

• __SERVICE_MQ_HOST : RabbitMQ host
• __SERVICE_MQ_VHOST: RabbitMQ virtual host
• __SERVICE_MQ_QUEUE: RabbitMQ queue name
• __SERVICE_MQ_USER: RabbitMQ user
• __SERVICE_MQ_PASSWORD: RabbitMQ password
• __SERVICE_MQ_EXCHANGE: RabbitMQ exchange (For dead letter queue feature)
• __SERVICE_MQ_ROUTING_KEY: RabbitMQ routing key (For dead letter queue feature)
• __SERVICE_SQLALCHEMY_DATABASE_URI: SQLAlchemy database URI
• __SERVICE_DB_TABLE_NAME: Database table name
• __SERVICE_API_TITLE: Swagger UI title
• __SERVICE_API_VERSION: API version
• __SERVICE_OPENAPI_URL_PREFIX: OpenAPI URL prefix
• __SERVICE_OPENAPI_SWAGGER_UI_PATH: Swagger UI path
• __SERVICE_OPENAPI_JSON_PATH: OpenAPI JSON path
• __SERVICE_OPENAPI_SWAGGER_UI_URL: Swagger UI Library URL
• __SERVICE_ACTUATOR_BASE_URI: Actuator base URI