README.md

codemen-rest

How to get started:

Clone the repo and run docker-compose up in the root directory.
The app will be available at http://localhost:8080/.
Swagger documentation is available at http://localhost:8080/swagger-ui.html.

Tech used:

PostgreSQL
Spring Boot
Spring Data JPA with Hibernate under the hood
Spring Web
Swagger
Docker and docker-compose
Flyway migrations

DONE

API versioning
Input validation
Proper error handling
DTO usage
Swagger docs

COULD BE IMPROVED

Tests for the api need to be added
Swagger documentation could be improved by adding extra annotations

Soft-delete could be added for the users via timestamps
Auth could be added

Could add sorting to GET all, e.g. ASC, DESC