danvinicius / product-catalog-management-system

API built using Java, Java Spring, AWS SQS, AWS SNS and AWS S3 services for the Anotaai Backend Challenge. The aim of this project is to practice Java and Spring Framework with message-queueing concepets.

About

API built using Java, Java Spring, AWS SQS, AWS SNS and AWS S3 services for the Anotaai Backend Challenge.
The aim of this project is to practice Java and Spring Framework with message-queueing concepets.

Product Catalog Management System

✅ Finished ✅

Table of Contents

• Installation
• Configuration
• System Design
• Usage
• API Endpoints

Installation

1. Clone the repository:

git clone https://github.com/danvinicius/product-catalog-management-system.git

2. Install dependencies with Maven

Configuration

1. Create a configuration with your runtime environment variables with your AWS Credentials that are used in application.properties

aws.region=us-east-1
aws.accessKeyId=111111
aws.secretKey=111111

2. Run MongoDB with Docker

docker run -p 27017:27017 -d mongo

System Design

Usage

1. Start the application with Maven
2. The API will be accessible at http://localhost:8080

API Endpoints

The API provides the following endpoints:

API product

POST /api/product - Create a new product
GET /api/product - Retrieve all products
PUT /api/product/{id} - Updates a product
DELETE /api/product/{id} - Delete a product

Body

{
  "title": "Produto para postar no tópico",
  "description": "",
  "ownerId": "4444444",
  "categoryId": "659d558b0304df732ddd4587",
  "price": 10000
}

API category

POST /api/category - Create a new category
GET /api/category - Retrieve all categories
PUT /api/category/{id} - Updates a category
DELETE /api/category/{id} - Delete a category

Body

{
  "id": "393948882828",
  "title": "Teste",
  "description": "",
  "ownerId": "4444444"
}

Install GIT and Java on your computer.