IDEA EDU Course

Implemented in the Spring Security for Java Backend Developer Track of hyperskill.org's JetBrain Academy.
https://hyperskill.org/projects/180

Project goal is to implement a Spring boot recipe application with Spring Security and persisting into an H2 database.

Technology / External Libraries

• Java 20
• Spring Boot 3.1.1 (with Spring Security 6.1.x and Oauth2-Resource-server)
• Native image on GraalVM (Liberica 17.0.7)
• Spring Web using "classical" WebMvC @RestController-style
• Spring Data JPA and Validate
• Postgres Database
• Lombok
• Spring Tests with MockMvC
• Gradle 8.2

Program description

The application represents a program, that receives recipes voa REST-endpoints and stores them in a database. We create a multi-user web service with Spring Boot that allows storing, retrieving, updating, and deleting recipes.

Currently implemented endpoints:

POST /api/register (unauthenticated). -> post email and password as Json to register. Returns 200 OK on success or 400 BAD REQUEST, if invalid Json or User with email already exists. The request JSON looks as:

{
"email": "hans.wurst@xyz.de",
"password": "topsecret",
}

The password needs 8 characters, email is checked as valid format.

POST /api/recipe/new (authenticated). -> post a recipe as Json to persist it server-side with the timestamp and the creator. The request JSON looks as:

{
"name": "apple pie",
"category": "bakery",
"description": "easy apple pie",
"ingredients": ["100 g sugar", "200 g butter", "5 apples"],
"directions": ["make dough", "put in oven", "bake at 200°"]
}

It returns the id in the database as key-value object.

GET /api/recipe/{id} (authenticated). -> receives recipe with id from the database.

DELETE /api/recipe/{id} (authenticated). -> delete recipe with id if the principal is the creator. In this case returns 204, if not 403 FORBIDDEN is returned or 404 not Found, if recipe with id does not exist.

PUT /api/recipe/{id} (authenticated). -> receives a recipe as a JSON object and updates the recipe with specified id if the principal is the creator. In this case returns 204, if not 403 FORBIDDEN is returned or 404 not Found, if recipe with id does not exist. Also, updates the dateTime field.

GET /api/recipe/search/?category=search (authenticated).
GET /api/recipe/search/?name=search (authenticated). -> retrieve all recipes matching to either a case-insensitive category parameter search or a case-insensitive substring search on the name as a Json-array, which is sorted descending by update timestamp.

Project completion

Project was completed on 01.01.23.

Repository Contents

Sources for all project tasks (5 stages) with tests and configurations.

Progress

20.12.22 Project started. Just setup of build and repo with gradle.

23.12.22 Stage 1 completed. Post and get endpoint /api/recipe/ with full test coverage. Setup of typical Rest-Service package structure with mapping of Dto <-> entities

24.12.22 Stage 2 completed. Now recipes posted are added in a list starting with id=1. The get method needs a path variable containing the id. 404 is returned if the requested element does not exist or 400 in case the path variable is not in integer format.

26.12.22 Stage 3 completed. Now recipes posted are persisted in a H2 database. Also hibernate validation is performed on input - tested with a new fancy generic and record-capable JpaUnitTestValidator. A delete endpoint is added.

27.12.22 Stage 4 completed. Now recipes posted are persisted in a H2 database. Recipe entity gets additional category and an @UpdateTimestamp annotated LocalDateTime field. Put endpoint added to update recipe by id and a parameter search on category or name substrings with sorting by newest posted/ updated.

01.01.23 Stage 5 completed. Added Spring security v 6.0 and a register endpoint for users to register. Only registered users may access the api/recipe endpoints. Further update / delete actions are only permitted, if the session user is the creator of a recipe (creator stored in recipe table).

26.06.23 Image/artifact tag 0.3.0: Move to postgres-database. Implement Oauth2-authentication with oauth2-resource-server. Remove User management and register endpoint, since this will be handled by authorization server with OIDC.

until 30.09.23 Add custom observability with actuator and Micrometer, add DemoController for rendering image media types. Setup http-client with token retrieval from Spring authorization server and bearer token authorization. Permit all actuator endpoints for demo purposes. Add custom metrics recipe.not.found for recipe not found requests.