Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/andersonhsporto/user-api
Crud example made with spring, mysql and docker for learning proposes
https://github.com/andersonhsporto/user-api
docker docker-compose java17 maven mysql spring-boot
Last synced: 2 days ago
JSON representation
Crud example made with spring, mysql and docker for learning proposes
- Host: GitHub
- URL: https://github.com/andersonhsporto/user-api
- Owner: andersonhsporto
- Created: 2023-10-09T16:11:58.000Z (about 1 year ago)
- Default Branch: main
- Last Pushed: 2024-04-25T15:13:25.000Z (7 months ago)
- Last Synced: 2024-04-26T15:59:00.463Z (7 months ago)
- Topics: docker, docker-compose, java17, maven, mysql, spring-boot
- Language: Java
- Homepage:
- Size: 107 KB
- Stars: 0
- Watchers: 1
- Forks: 0
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
Awesome Lists containing this project
README
# User API
## Description
Example of a simple crud rest api
using [spring boot](https://spring.io/projects/spring-boot) and
[mysql](https://www.mysql.com/).
## Requirements
- [Java 17](https://www.oracle.com/java/technologies/javase-jdk11-downloads.html) - Programming language
- [Maven](https://maven.apache.org/) - Dependency manager
- [MySQL](https://www.mysql.com/) - Database
- [Docker](https://www.docker.com/) - Container manager
- [Docker Compose](https://docs.docker.com/compose/) - Container manager
- [Postman](https://www.postman.com/) - API testing
## Installation
This project requires a compatible Java 17 JDK installed and
a MySQL database running.
To help the installation process, a docker-compose file is provided
with a MySQL database and a instance of the application.
## Docker
To start the containers, run the following command:
```bash
docker-compose up -d
```
This command will start the containers in the background.
To start only the database, run the following command:
```bash
docker-compose up -d database
```
this command will start only the database container.
## Command line
To start the application, run the following command
with a instance of MySQL running:
```bash
mvn spring-boot:run
```
## Database Parameters
For learning purposes, the parameters are hardcoded in the application
and can be changed in
the [application.yaml](https://github.com/andersonhsporto/user-api/blob/main/src/main/resources/application.yaml)
file
or [application-docker.yml](https://github.com/andersonhsporto/user-api/blob/main/src/main/resources/application-docker.yaml)
in
docker environment.
| Parameter | Default Value | Description |
|-------------------|-----------------------------|-------------------|
| Database Host | localhost or docker service | Database host |
| Database Port | 3306 | Database port |
| Database Name | db | Database name |
| Database Username | user | Database username |
| Database Password | password | Database password |
## Endpoints
The following endpoints are available:
User endpoints:
| Method | Endpoint | Description |
|--------|--------------------|-------------------|
| GET | /api/v1/users | Get all users |
| GET | /api/v1/users/{id} | Get user by id |
| POST | /api/v1/users | Create a new user |
| PUT | /api/v1/users/{id} | Update user by id |
| DELETE | /api/v1/users/{id} | Delete user by id |
## Examples
To help the testing process, below are some examples of
requests and responses.
The name, username and password, birth date are required fields,
birth date must be in the format dd-MM-yyyy.
The password must be 6 characters long and it will never be returned
for security reasons.
### Create user
To create a new user, send a POST request to the endpoint
which will return the created user.
#### Request:
```bash
curl --location --request POST 'http://localhost:8080/api/v1/users' \
--header 'Content-Type: application/json' \
--data-raw '{
"name": "John Doe",
"username": "johndoe",
"password": "123456",
"dateOfBirth": "01-01-2000"
}'
```
#### Json:
```json
{
"name": "John Doe",
"username": "johndoe",
"password": "123456",
"dateOfBirth": "01-01-2000"
}
```
#### Return:
```json
{
"id": 1,
"name": "John Doe",
"username": "johndoe",
"dateOfBirth": "01-01-2000",
"createdAt": "2021-10-10T00:00:00.000+00:00",
"updatedAt": "2021-10-10T00:00:00.000+00:00"
}
```
### Update user
To update a user, send a PUT request to the endpoint
which will return the updated user.
##### Request:
```bash
curl --location --request PUT 'http://localhost:8080/api/v1/users/1' \
--header 'Content-Type: application/json' \
--data-raw '{
"name": "John Doe 2",
"username": "johndoe2",
"password": "123457",
"dateOfBirth": "01-01-2000"
}'
```
#### Return:
```json
{
"id": 1,
"name": "John Doe 2",
"username": "johndoe2",
"dateOfBirth": "01-01-2000",
"createdAt": "2021-10-10T00:00:00.000+00:00",
"updatedAt": "2021-10-10T00:00:00.000+00:00"
}
```
### Get user by id
To get a user by id, send a GET request to the endpoint
which will return the user.
#### Request:
```bash
curl --location --request GET 'http://localhost:8080/api/v1/users/1'
```
#### Return:
```json
{
"id": 1,
"name": "John Doe 2",
"username": "johndoe2",
"dateOfBirth": "01-01-2000",
"createdAt": "2021-10-10T00:00:00.000+00:00",
"updatedAt": "2021-10-10T00:00:00.000+00:00"
}
```
### Get all users
To get all users, send a GET request to the endpoint
which will return all users.
#### Request:
```bash
curl --location --request GET 'http://localhost:8080/api/v1/users'
```
#### Return:
```json
[
{
"id": 1,
"name": "John Doe 2",
"username": "johndoe2",
"dateOfBirth": "01-01-2000",
"createdAt": "2021-10-10T00:00:00.000+00:00",
"updatedAt": "2021-10-10T00:00:00.000+00:00"
},
{
"id": 2,
"name": "John Doe 3",
"username": "johndoe3",
"dateOfBirth": "01-01-2000",
"createdAt": "2021-10-10T00:00:00.000+00:00",
"updatedAt": "2021-10-10T00:00:00.000+00:00"
}
]
```
### Delete user by id
To delete a user by id, send a DELETE request to the endpoint
which will return status 204 (No Content).
#### Request:
```bash
curl --location --request DELETE 'http://localhost:8080/api/v1/users/1'
```
#### Return:
```json
204 No Content
```
## Contact Information
If you have any questions, suggestions or comments, please contact me.
through the [email](mailto:[email protected]) or
[linkedin](https://www.linkedin.com/in/andersonhsporto/).