https://github.com/deverebor/marketplace-api

This is a simple API made with SpringBoot with deploy on heroku.
https://github.com/deverebor/marketplace-api

heroku hibernate-jpa java-18 side-project spring-boot

Last synced: 14 days ago
JSON representation

This is a simple API made with SpringBoot with deploy on heroku.

• Host: GitHub
• URL: https://github.com/deverebor/marketplace-api
• Owner: deverebor
• Created: 2022-08-14T11:36:08.000Z (over 2 years ago)
• Default Branch: main
• Last Pushed: 2022-08-21T12:47:14.000Z (over 2 years ago)
• Last Synced: 2024-11-06T23:33:53.396Z (2 months ago)
• Topics: heroku, hibernate-jpa, java-18, side-project, spring-boot
• Language: Java
• Homepage:
• Size: 827 KB
• Stars: 1
• Watchers: 2
• Forks: 0
• Open Issues: 1
• Metadata Files:
  • Readme: README.md

Awesome Lists containing this project

README

        
# Marketplace API - Java 18

![GitHub language count](https://img.shields.io/github/languages/count/deverebor/marketplace-api?style=for-the-badge)

![GitHub forks](https://img.shields.io/github/forks/deverebor/marketplace-api?style=for-the-badge)

![GitHub issues](https://img.shields.io/github/issues/deverebor/marketplace-api?style=for-the-badge)

![GitHub pull requests](https://img.shields.io/github/issues-pr/deverebor/marketplace-api?style=for-the-badge)

---

> This is a simple API made with SpringBoot with deploy on heroku.

## About project

This API came as part of professor Nélio Alves' JAVA course. 

Where I went further and created unit tests and restructured some endpoints.

## Feature list

Marketplace returns the following status codes in its API:

| Functionality                                                | Verb     | Description           | Authentication |

|:-------------------------------------------------------------|:---------|:----------------------|:---------------|

| https://api-marketplace-course.herokuapp.com/user            | `GET`    | Lists all users.      | `FALSE`        |

| https://api-marketplace-course.herokuapp.com/user/{id}       | `GET`    | Lists a user.         | `FALSE`        |

| https://api-marketplace-course.herokuapp.com/order/          | `GET`    | Lists all orders.     | `FALSE`        |

| https://api-marketplace-course.herokuapp.com/order/{id}      | `GET`    | List an order.        | `FALSE`        |

| https://api-marketplace-course.herokuapp.com/categories      | `GET`    | Lists all categories. | `FALSE`        |

| https://api-marketplace-course.herokuapp.com/categories/{id} | `GET`    | Lists a category.     | `FALSE`        |

| https://api-marketplace-course.herokuapp.com/product/        | `GET`    | Lists all products.   | `FALSE`        |

| https://api-marketplace-course.herokuapp.com/product/{id}    | `GET`    | Lists a product.      | `FALSE`        |

| https://api-marketplace-course.herokuapp.com/user/{id}       | `DELETE` | Removes a user.       | `FALSE`        |

| https://api-marketplace-course.herokuapp.com/user/{id}       | `POST`   | Adds a user.          | `FALSE`        |

| https://api-marketplace-course.herokuapp.com/user/{id}       | `PUT`    | Updates a user.       | `FALSE`        |

### Adjustments and improvements

The project is concluded but there are some points of improvement:

- [X] Migrate the database structure to postgresql

- [ ] Add unit tests to routes and their dependencies

- [X] Deploy on HEROKU.

## 💻 Prerequisites

Before you begin, make sure that you have met the following requirements:

* You have installed the version of 'java 18'.

* You have Postman installed to view how the API works ([CLICK HERE to access JSON with requests](./docs/postman)).

## 📫 Contribute to the project

Follow this steps to contribute to the project:

1. Fork this repository.

2. Create a branch: `git checkout -b feat: `.

3. Make your changes and confirm them: `git commit -m 'feat: '`.

4. Send to the original branch: `git push deverebor/fastapi-blog-api`

5. Create the pull request.

Alternatively, see the GitHub documentation at https://help.github.com/en/github/collaborating-with-issues-and-pull-requests/creating-a-pull-requests).

[⬆ Voltar ao topo](#fastapi-blog-api)