This project is a Spring Boot-based REST API that serves as a backend for a product management system. It includes Swagger UI for easy documentation and testing of API endpoints.
-
Spring Boot: A powerful and convention-over-configuration-based Java framework for building standalone and production-grade Spring-based applications.
-
Spring Data JPA: A part of the larger Spring Data project, it makes it easy to implement JPA-based repositories.
-
Swagger UI: An open-source tool for generating interactive API documentation. It allows developers to visualize and interact with the API's resources without having any of the implementation logic in place.
- Java Development Kit (JDK) installed on your machine.
- Maven for building and managing the project.
-
Clone the repository:
git clone https://github.com/sabeer02/REST-API.git
-
Navigate to the project directory:
cd REST-api -
Run the application:
IDE - SPRING TOOL SUITE
The application will start on http://localhost:8080.
Swagger UI documentation is available at http://localhost:8080/swagger-ui.html. Use this interface to explore and test the different API endpoints for CRUD operations on employee records.
Here are some of the key API endpoints provided by this REST API:
- List all products
- Add new Product
- Update Product
- Delete Product