janssenbatista/places-api

Places API

Clickbus company back-end code challenge resolution.

🔨 Execute the application in a Docker Container

Requirements:

• Docker
• Docker Compose

Create the application's .jar file with the following command:

./gradlew clean build

Then upload the application and database containers with the following command:

docker compose up -d

📕 API Endpoints

POST /places (create a place)

GET /places/{id} (get a place by id)

GET /places[?name="query"] (get all places or places filtered by containing name)

PUT /places/{id} (update a place)

DELETE /places/{id} (delete a place by id)

❗To see details of all endpoints run the application and open the Swagger UI documentation

url: http://{host}:[port]/swagger-ui.html