Spring Boot Example

/GET /POST /PUT /DELETE APIs for managing cakes.

Tech stack

• Java 17
• Spring boot - CRUD operations for managing cakes; application exposed on port 8081
• Spring boot security - basic authentication applied to all APIs
• H2 database - for production and test code
• Swagger
• OpenApi
• Wiremock - for integration tests - stubbing the external URL from where cakes database is populated on application startup (see src/test/resources/mappings/cakes.json file)
• Spring integration tests using WebTestClient
• Junit5, AssertJ
• Cucumber, Spring boot cucumber
• Lombok
• Maven
• Docker
• Github Actions - for CI/CD, see .github folder and Actions tab on this page

Prerequisites

In order to build the project, you will have to install the following:

• Java 17
• Maven
• Docker (optional)
• This project includes Lombok Annotations, this means that in order for your IDE to correctly compile your project you'll need to add the Lombok plugin to your IDE and Enable annotation processing (for IntelliJ IDEA).

Build

Maven

mvn clean install

Docker

docker build -t cake-service .

Run

Maven

mvn spring-boot:run

Docker

docker run -p 8081:8081 cake-service

Swagger / OpenApi

Swagger endpoint: http://localhost:8081/swagger-ui/index.html

OpenApi endpoint: http://localhost:8081/v3/api-docs

Important: swagger/openapi dependency for spring-boot 3 is now springdoc-openapi-starter-webmvc-ui

APIs

All APIs are secured using basic auth. Use the following credentials when making requests:

username=cake-user
password=cake-password-which-should-be-kept-in-a-secret-place-and-injected-when-application-is-deployed

• GET /cakes

curl 'localhost:8081/cakes' \
-u "cake-user:cake-password-which-should-be-kept-in-a-secret-place-and-injected-when-application-is-deployed"

• GET /cakes/{cake_id}

curl 'localhost:8081/cakes/15' \
-u "cake-user:cake-password-which-should-be-kept-in-a-secret-place-and-injected-when-application-is-deployed"

• POST /cakes

curl -X POST 'localhost:8081/cakes' \
-u "cake-user:cake-password-which-should-be-kept-in-a-secret-place-and-injected-when-application-is-deployed" \
--header 'Content-Type: application/json' \
--data-raw '{
    "title": "some title",
    "description": "some description"
}'

• PUT /cakes/{cake_id}

curl -X PUT 'localhost:8081/cakes/15' \
-u "cake-user:cake-password-which-should-be-kept-in-a-secret-place-and-injected-when-application-is-deployed" \
--header 'Content-Type: application/json' \
--data-raw '{
    "title": "some title updated",
    "description": "some description updated"
}'

• DELETE /cakes/{cake_id}

curl -X DELETE 'localhost:8081/cakes/15' \
-u "cake-user:cake-password-which-should-be-kept-in-a-secret-place-and-injected-when-application-is-deployed"

Cucumber

Spring Boot Cucumber configuration

• CakeCucumberSpringConfiguration.java
• RunCucumberTest.java

Data table transformers

• CakeDataTableTransformers.java

Feature files and step definitions

• src/test/resources/features/cakes.feature
• CakeStepDefs.java

IntelliJ IDEA Cucumber plugin

• https://plugins.jetbrains.com/plugin/7212-cucumber-for-java

Notes:

• The CakeDatabasePopulatorTest integration test is using Wiremock to stub the external URL for loading cakes. The file mapping of that response is located under src/test/resources/mappings/cakes.json.