This is a simple Java-based mini RESTful API project that demonstrates basic CRUD (Create, Read, Update, Delete) operations. The project uses the Spring Boot framework to build a lightweight and easily deployable API. You can download the Chrome extension Talend API Tester to experiment with API.
Follow these instructions to get a copy of the project up and running on your local machine.
- Java Development Kit (JDK) - version 17 or later
- Maven - for building and managing the project dependencies
- Ensure Spring Boot version is 3.1 or higher
- Docker Desktop
- MySQL Shell
-
Clone the repository:
git clone https://github.com/your-username/mini-restful-api-java.git
-
Navigate to the project directory:
cd mini-restful-api-java -
Build the project using Maven:
mvn clean install
-
Run the application:
java -jar target/mini-restful-api.jar
The API will be accessible at http://localhost:8080.
-
Endpoint:
/users -
HTTP Method:
POST -
Request Body:
{ "user_name": "John", "birth_date": "2014-01-01" }
- Endpoint:
/users - HTTP Method:
GET
- Endpoint:
/users/{Id} - HTTP Method:
GET
- Endpoint:
/users/{Id} - HTTP Method:
DELETE
- Spring Boot - Framework for building Java-based applications
- Maven - Dependency management
This project is licensed under the MIT License - see the LICENSE file for details.