DVS server API

Scala application with ReST and web-socket APIs serving aggregated flight events. Part of the DVS project.

Configuration

The application references the following environment variables:

• HOST: server host
• PORT: server port
• KAFKA.BOOTSTRAP.SERVERS: valid bootstrap.servers value (see Confluent docs)
• SCHEMAREGISTRY.URL: valid schema.registry.url value (see Confluent docs)
• SERVER.WEBSOCKET.MAX.NUMBER.FLIGHTS: max number of elements returned by API
• SERVER.WEBSOCKET.THROTTLE.DURATION: time interval between each update

API documentation

Web-socket APIs are documented using AsyncAPI standard in this descriptor.

How to test

Execute unit tests running the following command:

sbt test

Execute integration tests running the following command:

sbt it:test

How to build

Build and publish Docker image running the following command:

sbt docker:publish

Architectural diagram

Architectural diagram is available here. It can be rendered using PlantText.

Contribution

If you'd like to contribute to the project, make sure to review our recommendations.