Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/talesmousinho/user-demo
A practical exercise to demonstrate proficiency in REST API development.
https://github.com/talesmousinho/user-demo
Last synced: 2 days ago
JSON representation
A practical exercise to demonstrate proficiency in REST API development.
- Host: GitHub
- URL: https://github.com/talesmousinho/user-demo
- Owner: talesmousinho
- Created: 2023-12-15T10:50:22.000Z (about 1 year ago)
- Default Branch: main
- Last Pushed: 2024-02-09T19:34:29.000Z (11 months ago)
- Last Synced: 2024-11-08T14:47:19.815Z (about 2 months ago)
- Language: Java
- Size: 94.7 KB
- Stars: 0
- Watchers: 2
- Forks: 0
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
Awesome Lists containing this project
README
# Project: User Demonstration REST Endpoint
This project is a technical challenge to implement CRUD operations through the development of a REST API for user management, it serves as a practical exercise to demonstrate proficiency in REST API development.
## Index
- [Summary](#summary)
- [Features](#features)
- [Entities](#entities)
- [Requirements](#requirements)
- [Issues](#issues)
- [How to Run](#how-to-run)
- [Swagger UI](#swagger-ui)
## Summary
This project is a technical challenge to implement CRUD operations through the development of a REST API for user management.
The API receives and returns values in JSON format. It allows users to create, read, update, and delete User entities. Each User entity has a name, surname, and birthdate.
The API is built using Java 17, Spring Boot 2.7, and an in-memory database. It is designed to be easy to set up and run, with detailed instructions provided in the "[How to Run](#how-to-run)" section.
## Features
The system provides the following features:
- Get all users, with pagination and sorting
- Get user by ID
- Create new user
- Modify user
- Delete user
## Entities
- User
- ID
- Name
- Lastname
- Created At (DB Entity level)
- Updated At (DB Entity level)
## Requirements
The API is built with Java 17, Spring Boot 2.7, Spring JPA, and H2 Database.
## Issues
The development of this project was organized into the following tasks, each represented by a GitHub issue:
1. [Implement User Entity with Basic Attributes](https://github.com/talesmousinho/user-demo/issues/1)
2. [Create Endpoint to Retrieve All Users](https://github.com/talesmousinho/user-demo/issues/2)
3. [Create Endpoint to Retrieve a User by ID](https://github.com/talesmousinho/user-demo/issues/3)
4. [Create Endpoint to Add a New User](https://github.com/talesmousinho/user-demo/issues/4)
5. [Create Endpoint to Update User Information](https://github.com/talesmousinho/user-demo/issues/5)
6. [Create Endpoint to Delete a User](https://github.com/talesmousinho/user-demo/issues/6)
7. [Create JUnit Tests for User Controller Endpoints](https://github.com/talesmousinho/user-demo/issues/7)
8. [Add Swagger UI for API Documentation](https://github.com/talesmousinho/user-demo/issues/8)
## How to Run
### Prerequisites
- Java 17
1. Clone the repository to your local machine.
```bash
git clone [email protected]:talesmousinho/user-demo.git
```
2. Navigate to the project directory.
```bash
cd user-demo/
```
3. Build the project using Maven.
```bash
./mvnw clean install
```
4. Run the Spring Boot application.
```bash
java -jar target/user-demo-server-0.0.1-SNAPSHOT.jar
```
The application will start running at http://localhost:8080.
## Swagger UI
Swagger UI is integrated for easy testing and interaction with the API. To access Swagger UI, once the application is running, visit http://localhost:8080/swagger-ui.html in your web browser.