https://github.com/nickemma/springboot-rest-api

This project is a RESTful API developed using Spring Boot. It serves as a backend service for managing products in a catalog. Users can perform CRUD (Create, Read, Update, Delete) operations on products.
https://github.com/nickemma/springboot-rest-api

docker dto-pattern java maven mockito postgresql spring spring-boot spring-data-jpa

Last synced: about 5 hours ago
JSON representation

This project is a RESTful API developed using Spring Boot. It serves as a backend service for managing products in a catalog. Users can perform CRUD (Create, Read, Update, Delete) operations on products.

• Host: GitHub
• URL: https://github.com/nickemma/springboot-rest-api
• Owner: nickemma
• License: mit
• Created: 2024-07-17T23:21:48.000Z (4 months ago)
• Default Branch: main
• Last Pushed: 2024-07-24T16:59:24.000Z (4 months ago)
• Last Synced: 2024-07-25T00:32:24.790Z (4 months ago)
• Topics: docker, dto-pattern, java, maven, mockito, postgresql, spring, spring-boot, spring-data-jpa
• Language: Java
• Homepage:
• Size: 31.3 KB
• Stars: 0
• Watchers: 2
• Forks: 0
• Open Issues: 0
• Metadata Files:
  • Readme: README.md
  • License: LICENSE

Awesome Lists containing this project

README

        
# Spring Boot REST API for Product Management

## Overview

This is a RESTful API developed using Spring Boot, designed to manage a catalog of products. It includes features such as user registration, authentication, and CRUD operations for products. The API uses MongoDB to store product information and secures endpoints using JWT tokens.

## Features

- **User Registration and Authentication**: Allows users to register and log in to access the API.

- **JWT Token Authentication**: Secures API endpoints and validates user sessions.

- **CRUD Operations for Products**: Authenticated users can create, read, update, and delete products.

- **Input Validation**: Ensures data integrity through validation.

- **Error Handling**: Provides meaningful error messages for better debugging and user experience.

## Technologies

- **Spring Boot**

- **Spring Security**

- **JWT**

- **MongoDB**

- **Maven**

## Prerequisites

- **Java**: Ensure you have JDK 8 or later installed.

- **MongoDB**: Make sure MongoDB is installed and running.

- **Maven**: Ensure Maven is installed for dependency management.

## Getting Started

### Clone the Repository

```sh

git clone https://github.com/nickemma/springboot-rest-api.git

cd springboot-rest-api

``` 

### Build and Run the Application

Use Maven to build and run the application:

```sh

mvn clean install

mvn spring-boot:run

```

The application will start on `http://localhost:8080`.

### API Documentation

The API documentation is available at `http://localhost:8080/swagger-ui.html`.

### License

This project is licensed under the [MIT](LICENSE) - see the LICENSE file for details.

## Acknowledgments

- [Instructor](https://aliboucoding.com/courses/) for the teaching inspiration to learn spring boot.

Feel free to adjust the content to better fit your project specifics and personal preferences. If you need further customization or additional sections, let me know!