ChatDeBlofeld / Underification

TrainingREST

Build and run the Fruit microservice

You can use maven to build and run the REST API implementation from the command line. After invoking the following maven goal, the Spring Boot server will be up and running, listening for connections on port 8080.

docker-compose up -d underification_db
cd fruits-impl/
mvn spring-boot:run

You can then access:

• the API documentation, generated from annotations in the code
• the API endpoint, accepting GET and POST requests

You can use curl to invoke the endpoints:

• To retrieve the list of fruits previously created:

curl -X GET --header 'Accept: application/json' 'http://localhost:8080/fruits'

• To create a new fruit (beware that in the live documentation, there are extra \ line separators in the JSON payload that cause issues in some shells)

curl -X POST --header 'Content-Type: application/json' --header 'Accept: */*' -d '{
  "colour": "red",
  "expirationDate": "2020-11-06",
  "expirationDateTime": "2020-11-06T05:43:27.909Z",
  "kind": "apple",
  "size": "small",
  "weight": "light"
}' 'http://localhost:8080/fruits'

Test the Fruit microservice by running the executable specification

You can use the Cucumber project to validate the API implementation. Do this when the server is running.

cd cd fruits-specs/
mvn clean test

You will see the test results in the console, but you can also open the file located in ./target/cucumber

Deployment

As always and for the rest of our lives, we provide a beautiful handcrafted docker image.

Just run:

docker-compose up -d

Note: You may want to change the database credentials in the compose file for obvious security purposes.