https://github.com/pedroh183/apianotaaichallenge

AWS catalog microservice: S3 for storage, SQS for queues. Scalable & resilient data management.
https://github.com/pedroh183/apianotaaichallenge

aws aws-lambda aws-s3 java mongodb spring

Last synced: 5 months ago
JSON representation

AWS catalog microservice: S3 for storage, SQS for queues. Scalable & resilient data management.

• Host: GitHub
• URL: https://github.com/pedroh183/apianotaaichallenge
• Owner: PedroH183
• Created: 2024-02-14T01:23:37.000Z (over 1 year ago)
• Default Branch: main
• Last Pushed: 2024-03-02T22:59:24.000Z (over 1 year ago)
• Last Synced: 2025-05-09T01:50:00.801Z (5 months ago)
• Topics: aws, aws-lambda, aws-s3, java, mongodb, spring
• Language: Java
• Homepage:
• Size: 88.9 KB
• Stars: 0
• Watchers: 1
• Forks: 1
• Open Issues: 0
• Metadata Files:
  • Readme: Readme.md

Awesome Lists containing this project

README

          
# Restaurant Marketplace

## AnotaAi Backend Challenge

![Java](https://img.shields.io/badge/java-%23ED8B00.svg?style=for-the-badge&logo=openjdk&logoColor=white)

![Spring](https://img.shields.io/badge/spring-%236DB33F.svg?style=for-the-badge&logo=spring&logoColor=white)

[![Licence](https://img.shields.io/github/license/Ileriayo/markdown-badges?style=for-the-badge)](./LICENSE)

![MongoDB](https://img.shields.io/badge/MongoDB-%234ea94b.svg?style=for-the-badge&logo=mongodb&logoColor=white)

![AWS](https://img.shields.io/badge/AWS-%23FF9900.svg?style=for-the-badge&logo=amazon-aws&logoColor=white)

This project is an API built using **Java, Java Spring, AWS Simple Queue Service, Mongo DB and AWS Simple Storage Service.**

The Microservice was developed with Fernanda Kipper [Youtube Channel](https://youtu.be/a3tPHH8uwPc?si=vFf-S2H5i3IpVTjN), to demonstrate how to solve the [AnotaAi Backend Challenge](https://github.com/githubanotaai/new-test-backend-nodejs).

## A basic documentation of steps on how to implement this project using AWS.

[![Notion](https://img.shields.io/badge/Notion-000000?style=for-the-badge&logo=notion&logoColor=white)](https://www.notion.so/AWS-1bc71eaa91564d2189bc2066db6f62f0)

## Table of Contents

- [Installation](#installation)

- [Configuration](#configuration)

- [Usage](#usage)

- [API Endpoints](#api-endpoints)

- [Database](#database)

- [Contributing](#contributing)

## Installation

1. Clone the repository:

```bash

git@github.com:PedroH183/ApiAnotaAiChallenge.git

```

2. Install dependencies with Maven

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

```yaml

aws.region=us-east-1

aws.accessKeyId=${AWS_KEY_ID}

aws.secretKey=${AWS_SECRET}

```

**Config Values**

```yaml

AWS_KEY_ID=VALUE;AWS_SECRET=VALUE2

```

## 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**

```markdown

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**

```json

{

  "title": "Produto para postar no tópico",

  "description": "",

  "ownerId": "4444444",

  "categoryId": "659d558b0304df732ddd4587",

  "price": 10000

}

```

**API CATEGORY**

```markdown

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**

```json

{

  "id": "393948882828",

  "title": "Teste",

  "description": "",

  "ownerId": "4444444"

}

```