Welcome to the Java REST Application repository created using Spring Tool Suite (STS)!
This project serves as a template for building RESTful APIs using Java and Spring Boot framework.
- RESTful Endpoints: Implements RESTful endpoints to perform CRUD operations.
- Spring Boot: Utilizes Spring Boot framework for easy application setup and development.
- Database Integration: Demonstrates database integration for data storage using Spring Data JPA.
- Swagger Documentation: Integrates Swagger for API documentation and exploration.
Follow these instructions to get a copy of the project up and running on your local machine for development and testing purposes.
- Java Development Kit (JDK) - Java 11 or later.
- Spring Tool Suite (STS) - Integrated Development Environment (IDE) for building Spring-based applications.
- Git - Version control system for managing project files.
-
Clone the repository to your local machine:
git clone https://github.com/your-username/java-rest-application.git
-
Import the project into Spring Tool Suite:
- Launch Spring Tool Suite.
- Select
File
>Import
. - Choose
Existing Maven Projects
and clickNext
. - Browse to the directory where you cloned the repository and select the project.
- Click
Finish
to import the project into STS.
-
Run the application:
- Right-click on the project in the Project Explorer.
- Go to
Run As
>Spring Boot App
. - Alternatively, you can run the application using Maven:
mvn spring-boot:run
.
-
Access the application:
- Once the application is running, you can access it at http://localhost:8080.
- Explore the API documentation using Swagger UI at http://localhost:8080/swagger-ui/index.html.
Contributions are welcome! Please read the CONTRIBUTING.md file for details on how to contribute to this project.
This project is licensed under the MIT License - see the LICENSE.md file for details.
- Hat tip to anyone whose code was used.
- Inspiration.
- etc.