survey-api project

This project uses Quarkus, the Supersonic Subatomic Java Framework.

If you want to learn more about Quarkus, please visit its website: https://quarkus.io/ .

Running the application in dev mode

You can run your application in dev mode that enables live coding using:

./mvnw quarkus:dev

Packaging and running the application

The application can be packaged using ./mvnw package. It produces the survey-api-1.0.0-SNAPSHOT-runner.jar file in the /target directory. Be aware that it’s not an über-jar as the dependencies are copied into the target/lib directory.

The application is now runnable using java -jar target/survey-api-1.0.0-SNAPSHOT-runner.jar.

Creating a native executable

You can create a native executable using: ./mvnw package -Pnative.

Or, if you don't have GraalVM installed, you can run the native executable build in a container using: ./mvnw package -Pnative -Dquarkus.native.container-build=true.

You can then execute your native executable with: ./target/survey-api-1.0.0-SNAPSHOT-runner

If you want to learn more about building native executables, please consult https://quarkus.io/guides/building-native-image.

Appendix 1 Running native application with h2 database

The native application cn be executed with default database driver - H2. It is in-memory database which can be used for testing purposes. When the application has been restarted the data will be lost.

H2 database provider startup command

./survey-api-1.0.0-SNAPSHOT-runner \
 -Dquarkus.datasource.db-kind=h2 \
 -Dquarkus.hibernate-orm.database.generation=update

Postgres database provider startup command

./survey-api-1.0.0-SNAPSHOT-runner \
 -Dquarkus.datasource.db-kind=postgresql \
 -Dquarkus.datasource.username=surveyapi \
 -Dquarkus.datasource.password=P@ssp0rt \
 -Dquarkus.datasource.jdbc.url=jdbc:postgresql://localhost:5432/surveyapi \
 -Dquarkus.hibernate-orm.database.generation=update

Microsoft SQL Server database provider startup command

./survey-api-1.0.0-SNAPSHOT-runner \
 -Dquarkus.datasource.db-kind=mssql \
 -Dquarkus.datasource.username=surveyapi \
 -Dquarkus.datasource.password=P@ssp0rt \
 -Dquarkus.datasource.jdbc.url=jdbc:sqlserver://localhost:1433;databaseName=SurveyApi \
 -Dquarkus.hibernate-orm.database.generation=update

The same options are available for all available executable formats. This means that you can start the jar executable with H2 database by:

java -jar survey-api-1.0.0-SNAPSHOT-runner.jar \
 -Dquarkus.datasource.db-kind=h2 \
 -Dquarkus.hibernate-orm.database.generation=update

Container image build

In order to build a container image please follow this guide: https://quarkus.io/guides/container-image

API example

Give answer for the quality of the service

The service has initial database which includes single question with id 1. In order to give an answer for this question execute:

curl --location --request POST 'http://{host}:8080/api/survey?s=0892329323&a=5&q=1'

where parameter 's' is the number which gives the survey, 'a' is the answer for question and thq 'q' parameter is the question id.

Export the surveys to csv format

In order to export the survey results into CVS execute the following request:

curl --location --request GET 'http://{host}:8080/api/search?start=2000-01-01T00:00&end=2021-01-01T00:00'

where parameters 'start' and 'end' are the dates between the values should be returned.

bsdimer/lanAdvice-surveyApi