diff --git a/README.md b/README.md index 44df63f..a60a606 100644 --- a/README.md +++ b/README.md @@ -1,11 +1,14 @@ -# Food Ordering System - Microservice Architecture +# Food Ordering System ### TODO: - RestaurantsAPI - OrdersProcessingAPI +## Overview +This project serves as an example of food ordering system using a microservice approach. + ## UserManagementAPI -Simple microservice for managing users built using Spring Boot and Kotlin. +Simple microservice for managing users, built using Spring Boot and Kotlin. ### How to run @@ -17,3 +20,10 @@ UserManagementAPI will be avaiable on ```localhost:8080/api/v1```. Access Swagge ### Unit Tests Before running unit tests, ensure that you have a local MongoDB instance running on ```localhost:27017```. + +### Endpoints +GET /api/v1/health +GET /api/v1/users +GET /api/v1/users/{id} +PUT /api/v1/users/{id} +DELETE /api/v1/users/{id}