Application that allows users to manage their recipes.

• JDK 17

Execute this command in your terminal to start Postgres

docker-compose up

In another terminal execute this command:

./gradlew bootRun

Open your browser on: http://localhost:8080

This is a Swagger page where you can call the API.

Execute in your terminal: ./gradlew test

This project was created following a Clean Architecture approach, where the code is organised in such a way that it encapsulates the business logic to isolate it from external factors.

The domain logic goes in the inner part, and should not depend on other layers. The main rule is: code on the inner layers can have no knowledge of functions on the outer layers.

The following layers was created:

• Domain layer:

  • entities, and value objects to represent the business model with business logic
  • domain services.
  • repositories to access data (as interface only).

• Application layer:

  • application services/use cases: orchestrates flow of data to and from domain layer.
  • mappers: maps DTO to and from Entity

• Infrastructure:

  • repository implementations: accessing data from DB or external source.
  • configurations
  • rest controllers

The application is making use of Open API for API specification and to generate API models that are used in the code base. (DTOs and Controllers Interface)

The application provides the following endpoints:

• /recipes: create, update, delete and search recipes
• /ingredients: loads only ingredients names that can be used on recipes search

Find more details in the OpenAPI spec here, or in the Swagger UI by running the application.

• Use Zalando Problem specification to standardize error responses
• Configure a database versioning tool (e.g. Flyway)
• Create CI/CD pipeline to build and deploy the application
• Use Test Containers to test specific queries running on Postgres