README.md

User Posts Management Service

Simple example application

All functional requirements are covered by unit tests.

API functional requirements

Feature	Description
add post	- needs to validate userId using an external API before saving
search post	- based on post id or userId - if the post is not found in the system, it needs to be searched using an external API and saved (valid only for searching using the post id)
remove post	- remove a post from the system
edit post	- ability to change the title and body of a post

All responses from external API need to be cached in system for 60 seconds

External API used for integration can be found here

Json Placeholder APIs

Apis used:

Posts API

Users API

Format of the post

Name	Typer
id	Integer
userId	Integer
title	String
body	String

This project uses

Tech stack
Java 17
Maven
Spring Boot 3
H2 (tests)
Postgres SQL
Flyway
Caffeine Cache
Spring Cache
Docker
Tomcat replaced by JBoss Undertow (no reason)
SpringDoc OpenAPI UI (Swagger UI)
Hibernate
CircleCI

Make sure to have installed

• Git

• JDK 17 or later

• Maven 3.8.8 or later

• Docker

Bash scripts for Maven, OpenJdk17 17 and Git

DB Structure

Flyway is used for automatic DB migration on application start.

• Flyway DB Migration scripts

Build & Test:

mvn clean install

Tests run in "test" profile and use in memory H2 db together with flyway

How to start:

Start dependencies in docker (this will start PostgreSQL container required to run this application, alternatively you can use your already running instance / container, just make sure to change application-dev.yml, app will create it's own schema)

docker-compose up -d

Start application in dev profile

java -jar -Dspring.profiles.active=dev user-posts-management-service\target\user-posts-management-service-0.0.1-SNAPSHOT.jar

Swagger UI:

This project uses OpenAPI for documentation

Swagger UI can be found under

{server-url}/api/user-posts-service/swagger-ui/index.html

For local testing, click here after running the application to redirect to Swagger UI

YAML API Specification:

Specification can be downloaded under

{server-url}/api/user-posts-service/v3/api-docs.yaml

For local testing, click here after running the application to download the file

Simplified visual representation