Skip to content

Latest commit

 

History

History
25 lines (20 loc) · 2.2 KB

starter-example.md

File metadata and controls

25 lines (20 loc) · 2.2 KB

SDA Commons Starter Example

This example module shows an application that uses the SdaPlatformBundle to bootstrap a Dropwizard application for use in the SDA Platform.

Beside the initialization of the bundle, it includes a REST endpoint to demonstrate registration of endpoints to map resources.

The integration test shows how the application is bootstrapped in tests. The tests show the capabilities of a standard platform application.

The provided local-config.yaml allows to start the application without the need for authentication locally using a run configuration of the favourite IDE that defines the program arguments server sda-commons-starter-example/local-config.yaml. Note that there will be no data available and the example application does not provide POST endpoints. All that is available is an empty array at GET /people and the simple Swagger documentation at GET /swagger.json or GET /swagger.yaml

The config.yaml is an example how the application can be started in production. Such file should be copied in the Docker container so that the variables can be populated using the environment configured by the orchestration tool (e.g. Kubernetes).