Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/francoriba/shelter_market_rest_api
Implementation of a REST API in Go. This project is related to the other two shelter projects. Lab3 for Operating Systems II at @FCEFyN UNC, AR.
https://github.com/francoriba/shelter_market_rest_api
continuous-integration docker dockercompose go postgresql rest-api reverse-proxy swagger traefik virtualization
Last synced: 3 months ago
JSON representation
Implementation of a REST API in Go. This project is related to the other two shelter projects. Lab3 for Operating Systems II at @FCEFyN UNC, AR.
- Host: GitHub
- URL: https://github.com/francoriba/shelter_market_rest_api
- Owner: francoriba
- License: mit
- Created: 2024-06-28T17:51:07.000Z (6 months ago)
- Default Branch: master
- Last Pushed: 2024-09-15T19:38:29.000Z (3 months ago)
- Last Synced: 2024-09-28T21:03:41.955Z (3 months ago)
- Topics: continuous-integration, docker, dockercompose, go, postgresql, rest-api, reverse-proxy, swagger, traefik, virtualization
- Language: Go
- Homepage:
- Size: 1.64 MB
- Stars: 0
- Watchers: 1
- Forks: 0
- Open Issues: 1
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
README
# New World
Problem to solve...
## 🎯 Objectives
This project aims to develop a robust and secure backend in Golang using the Fiber framework. It will serve as the technological backbone for a survival store that strategically manages and sells surplus supplies to other refugee communities.
## 📝 Evaluation Aspects
- **Code Quality and Architecture**: Implement a clean, well-organized Model-Service-Repository pattern ensuring modularity and maintainability.
- **Functionality**: Robust functionality across all server endpoints for accurate, real-time supply management.
- **Security**: Secure API access with JWT authentication to ensure data integrity and protect against unauthorized access. We are also using TLS as a security layer.
- **Scalability**: The application should be scalable, and designed to handle increasing loads and concurrent users efficiently.
- **Documentation**: Detailed documentation should include setup instructions, API usage examples, and deployment guidelines.
## 📽 🎞 New World
*As Joel and his team of survivors continue their mission to stabilize their world, the real-time monitoring application has become more than just a tool; it's a symbol of revival and human resilience. As they move beyond their underground confines, the survivors use their technological prowess to reach out to other isolated groups, hoping to expand their network and enhance their collective strength.*
*With the application's real-time data, they identify a series of potentially habitable zones unclaimed by the fungal scourge. Plans are swiftly put into motion to explore these areas. Each mission is carefully monitored from the control room, where the team can react instantly to any sign of danger or opportunity, adjusting their strategies based on live environmental data.*
*With surplus supplies now more abundant thanks to efficient resource management, the survivors initiate trade with nearby communities. They use the application to manage trade logs, monitor resource levels, and schedule deliveries, turning the refuge into a bustling trade hub. This economic activity brings a semblance of normalcy and hope, strengthening community bonds and fostering economic resilience.*
## 🔑 Application Description
Our backend application will interface with the existing HPCPP project to access and trade the current **20%** of the supply levels. Key components include:
- **Technology Stack**:
- **Fiber**: Utilized for creating a high-performance HTTP server.
- **Traefik**: Used as a reverse proxy and load balancer to efficiently manage and route requests.
- **JWT**: Ensures secure endpoint access, allowing only authenticated users to view the market.
- **Postgres**: Utilized for robust data storage and management.
- **Endpoints**:
POST /auth/register (Register a new user)
##### Parameters
> | name | type | data type | example |
> |-----------|-----------|-------------------------|-----------------------------------------------------------------------|
> | data | required | `application/json` | `{ "username": "john_doe", "email": "[email protected]", "password": "securepassword123" }` |
##### Responses
> | http code | content-type | response |
> |---------------|-----------------------------------|---------------------------------------------------------------------|
> | `500` | `application/json` | `{"code":"500","message":"Bad server"}` |
> | `201` | `application/json` | `{"code":"201","message":"User added"} ` |
> | `400` | `application/json` | `{"code":"400","message":"Bad request"}` |
##### Example httpie
> ```javascript
> echo -n '{ "username": "john_doe", "email": "[email protected]", "password": "securepassword123" }' | http POST localhost:3000/auth/register
> ```
POST /auth/login (Authenticate a user)
##### Parameters
> | name | type | data type | example |
> |-----------|-----------|-------------------------|-----------------------------------------------------------------------|
> | data | required | `application/json` | `{ "email": "[email protected]", "password": "securepassword123" }` |
##### Responses
> | http code | content-type | response |
> |---------------|-----------------------------------|---------------------------------------------------------------------|
> | `500` | `application/json` | `{"code":"500","message":"Bad server"}` |
> | `201` | `application/json` | `{"code":"200","auth":"JWT"} ` |
> | `400` | `application/json` | `{"code":"400","message":"Bad request"}` |
##### Example httpie
> ```javascript
> echo -n '{ "email": "[email protected]", "password": "securepassword123" }' | http POST localhost:3000/auth/register
> ```
GET /auth/offers (Retrieve a list of available offers)
##### Parameters
> | name | type | data type | example |
> |-----------|-----------|-------------------------|-----------------------------------------------------------------------|
> | data | required | `application/json` | `securityDefinitions: jwt: type: apiKey name: Authorization in: header` |
##### Responses
> | http code | content-type | response |
> |---------------|-----------------------------------|---------------------------------------------------------------------|
> | `500` | `application/json` | `{"code":"500","message":"Bad server"}` |
> | `200` | `application/json` | `{"code":"200",{"message":[{"id":"1","name":"meat","quantity":100,"price":10,"category":"food"},{"id":"2","name":"vegetables","quantity":200,"price":5,"category":"food"},{"id":"3","name":"fruits","quantity":150,"price":8,"category":"food"},{"id":"4","name":"water","quantity":1000,"price":2,"category":"drink"},{"id":"5","name":"antibiotics","quantity":50,"price":15,"category":"medicine"},{"id":"6","name":"analgesics","quantity":100,"price":8,"category":"medicine"},{"id":"7","name":"bandages","quantity":100,"price":5,"category":"medicine"},{"id":"8","name":"pistol ammo","quantity":200,"price":1,"category":"ammo"},{"id":"9","name":"rifle ammo","quantity":300,"price":1.5,"category":"ammo"},{"id":"10","name":"shotgun ammo","quantity":100,"price":2,"category":"ammo"}]}} ` |
> | `401` | `application/json` | `{"code":"401","message":"Unauthorized"}` |
##### Example httpie
> ```javascript
> http --auth-type=jwt --auth="" GET localhost:3000/auth/offers
> ```
POST /auth/checkout (Buy a list of orders)
##### Parameters
> | name | type | data type | example |
> |-----------|-----------|-------------------------|-----------------------------------------------------------------------|
> | data | required | `application/json` | `{"order":{ "id": 1, items: [{"quantity":10,"product_id":1},{"quantity":5, "product_id":4},{"quantity":3,"product_id":2}]}` |
> | data | required | `application/json` | `securityDefinitions: jwt: type: apiKey name: Authorization in: header` |
##### Responses
> | http code | content-type | response |
> |---------------|-----------------------------------|---------------------------------------------------------------------|
> | `500` | `application/json` | `{"code":"500","message":"Bad server"}` |
> | `200` | `application/json` | `{"code":"200",{"message":{"total":"1000","status":"pending"}`|
> | `401` | `application/json` | `{"code":"401","message":"Unauthorized"}` |
##### Example httpie
> ```javascript
> echo -n '{"order":{ "id": 1, items: [{"quantity":10,"product_id":1},{"quantity":5, "product_id":4},{"quantity":3,"product_id":2}]}' | http --auth-type=jwt --auth="" POST localhost:3000/auth/checkout
> ```
GET /auth/orders/:id (Get the status of a specific order)
##### Parameters
> | name | type | data type | example |
> |-----------|-----------|-------------------------|-----------------------------------------------------------------------|
> | data | required | `application/json` | `securityDefinitions: jwt: type: apiKey name: Authorization in: header` |
##### Responses
> | http code | content-type | response |
> |---------------|-----------------------------------|---------------------------------------------------------------------|
> | `500` | `application/json` | `{"code":"500","message":"Bad server"}` |
> | `200` | `application/json` | `{"code":"200",{"message":{"status":{ "preparing/processing/shipped/delivered"}`|
> | `401` | `application/json` | `{"code":"401","message":"Unauthorized"}` |
##### Example httpie
> ```javascript
> http --auth-type=jwt --auth="" GET localhost:3000/auth/orders/1
> ```
GET /admin/dashboard (Get status of all market)
##### Parameters
> | name | type | data type | example |
> |-----------|-----------|-------------------------|-----------------------------------------------------------------------|
> | data | required | `application/json` | `securityDefinitions: jwt: type: apiKey name: Authorization in: header role: Admin` |
##### Responses
> | http code | content-type | response |
> |---------------|-----------------------------------|---------------------------------------------------------------------|
> | `500` | `application/json` | `{"code":"500","message":"Bad server"}` |
> | `200` | `application/json` | `{"code":"200",{"message":{ "offers": [ {"id": "1", "name": "meat", "quantity": 100, "price": 10, "category": "food"}, {"id": "2", "name": "vegetables", "quantity": 200, "price": 5, "category": "food"}, {"id": "3", "name": "fruits", "quantity": 150, "price": 8, "category": "food"}, {"id": "4", "name": "water", "quantity": 1000, "price": 2, "category": "drink"}, {"id": "5", "name": "antibiotics", "quantity": 50, "price": 15, "category": "medicine"}, {"id": "6", "name": "analgesics", "quantity": 100, "price": 8, "category": "medicine"}, {"id": "7", "name": "bandages", "quantity": 100, "price": 5, "category": "medicine"}, {"id": "8", "name": "pistol ammo", "quantity": 200, "price": 1, "category": "ammo"}, {"id": "9", "name": "rifle ammo", "quantity": 300, "price": 1.5, "category": "ammo"}, {"id": "10", "name": "shotgun ammo", "quantity": 100, "price": 2, "category": "ammo"} ], "orders": [ {"id": "1", "status": "pending", "total": 1000}, {"id": "2", "status": "pending", "total": 1000}, {"id": "3", "status": "processing", "total": 1000}, {"id": "4", "status": "shipped", "total": 1000}, {"id": "5", "status": "delivered", "total": 1000} ], "balance": 5000 }`|
> | `401` | `application/json` | `{"code":"401","message":"Unauthorized"}` |
##### Example httpie
> ```javascript
> http --auth-type=jwt --auth="" GET localhost:3000/admin/dashboard
> ```
PATCH /admin/orders/:id (Update the status of a specific order)
##### Parameters
> | name | type | data type | example |
> |-----------|-----------|-------------------------|-----------------------------------------------------------------------|
> | data | required | `application/json` | `{"status":{ "preparing/processing/shipped/delivered" }` |
> | data | required | `application/json` | `securityDefinitions: jwt: type: apiKey name: Authorization in: header role: Admin` |
##### Responses
> | http code | content-type | response |
> |---------------|-----------------------------------|---------------------------------------------------------------------|
> | `500` | `application/json` | `{"code":"500","message":"Bad server"}` |
> | `200` | `application/json` | `{"code":"200",{"message":{"status":{ "preparing/processing/shipped/delivered"}`|
> | `401` | `application/json` | `{"code":"401","message":"Unauthorized"}` |
##### Example httpie
> ```javascript
> echo -n '{"status":{ "preparing/processing/shipped/delivered"}' | http --auth-type=jwt --auth="" PATCH localhost:3000/auth/orders/1
> ```
## 📌 Tasks to Implement
- **Initialize Fiber Application**: Set up the project structure and basic server functionalities using the Fiber framework.
- **Implement the Model-Service-Repository Pattern**: Define models for supply data, services for business logic processing, and repositories for database interactions.
- **Secure API with JWT**: Configure JSON Web Tokens for authentication and authorization processes.
- **Traefik Integration**: Set up and configure Traefik as the entry point for the application to handle request routing.
### 〽️ Bonus
- **Dockerization**: Containerize both the Go backend and the React frontend to simplify deployment processes. Use `docker-compose` for easy multi-container orchestration.
- **Frontend Integration**: Ensure that the provided React project interfaces seamlessly with the backend, implementing features for authentication and displaying the supplies data.
- **REDIS Integration**: Ensure seamless integration of REDIS for optimized caching and enhanced data retrieval efficiency.
- **Add more endpoints**: Improve the APP adding more endpoints.
GET /admin/users (Get all buyers, only for admins)
##### Parameters
> | name | type | data type | example |
> |-----------|-----------|-------------------------|-----------------------------------------------------------------------|
> | data | required | `application/json` | `securityDefinitions: jwt: type: apiKey name: Authorization in: header role: Admin` |
##### Responses
> | http code | content-type | response |
> |---------------|-----------------------------------|---------------------------------------------------------------------|
> | `500` | `application/json` | `{"code":"500","message":"Bad server"}` |
> | `200` | `application/json` | `{"code":"200",{"message":[{ "username": "john_doe", "email": "[email protected]"},...] } `|
> | `401` | `application/json` | `{"code":"401","message":"Unauthorized"}` |
DELETE /admin/users/ (Remove an customer)
##### Parameters
> | name | type | data type | example |
> |-----------|-----------|-------------------------|-----------------------------------------------------------------------|
> | data | required | `application/json` | `{"user": [ 1, 5 ] }` |
> | data | required | `application/json` | `securityDefinitions: jwt: type: apiKey name: Authorization in: header role: Admin` |
##### Responses
> | http code | content-type | response |
> |---------------|-----------------------------------|---------------------------------------------------------------------|
> | `500` | `application/json` | `{"code":"500","message":"Bad server"}` |
> | `200` | `application/json` | `{"code":"200",{"message":"success" } `|
> | `401` | `application/json` | `{"code":"401","message":"Unauthorized"}` |
Solution description
# Operating Systems Lab 3 Solution Description
## Architecture
## Project strucure
I followed [this](https://www.youtube.com/watch?v=EqniGcAijDI&t=453s&ab_channel=AnthonyGG) YT tutorial wich explains how to properly orginize an API project in Go and I made changes for my specific needs.
## General Details:
* I've integrated the frontend project with the API but only for the Register and Login features.
* Instead of making requests to the API's endpoints the users will make requests to the configured traefik routes:
* ```api.localhost/auth-admin/```
* ```vm-api.localhost/supplies?id=latest``` or ```vm-api.localhost/alerts```
* All endpoints have been implemented and documented with Swagger.
* Due to lack of time, i've only created tests for the endpoints that I considered most important:
* ```/auth/offers```
* ```/auth/login```
* ```/auth/register```
* ```/admin/users```
* ```/admin/dashboard```
* Given that the endpoints interacted with the postgres db, I used mocks to achive the creation of the tests.
* Everything is dockerized, we have different docker containers living insede the docker network ```"market_network"```:
* Frontend
* Traefik
* Go Rest API
* PosgresSQL database
* The HighPermormanceCPP API is not running in docker but in a VBox VM, in order to redirect traffic and request to this API I used a dynamic configuration file for Traefik.
## Endpoints Handlers Implementation Details:
/auth/register >> Register
* Handles the registration of a new user.
* Processes and validates registration data.
* Generates a hash for the user's password.
* Creates a new user with the default role and saves it to the database.
* Returns an appropriate response based on the operation's outcome.
/auth/login >> Login
* Handles user authentication.
* Processes and validates login credentials.
* Authenticates the user by verifying the provided credentials.
* Generates a JWT token if authentication is successful.
* Returns the JWT token to the client.
/auth/offers >> GetOffers
* Retrieves a list of available offers.
* Verifies authentication via the Authorization header.
* Validates and decodes the JWT token.
* Fetches offers from the database and returns them in the response.
/auth/checkout >> Checkout
* Handles the checkout process and order creation.
* Processes and validates checkout request data.
* Validates offer availability and calculates the total amount.
* Creates an order in the database and updates the stock of the offers.
* Returns an appropriate response based on the operation's outcome.
/auth/orders/:id >> GetOrderStatus
* Retrieves the status of a specific order.
* Verifies authentication via the Authorization header.
* Validates and decodes the JWT token.
* Retrieves the order ID from the URL and searches for the order in the database.
* Returns the order status in the response.
/admin/dashboard >> GetDashboard
* Retrieves the current status of all orders.
* Fetches orders and their items from the database.
* Prepares and returns a response with the dashboard data.
/admin/orders/:id >> UpdateOrderStatus
* Updates the status of a specific order.
* Validates the request and the new status value.
* Finds the order by ID and updates its status in the database.
* Returns an appropriate response based on the operation's outcome.
/admin/users >> GetAllUsers
* Retrieves all users with the role of "user".
* Fetches user data from the database.
* Prepares and returns a response with the list of users.
/admin/users/:id >> DeleteUser
* Deletes a user by ID.
* Finds the user by ID in the database.
* Deletes the user and returns an appropriate response based on the operation's outcome.
## Deployment
* To deploy this project you just need to clone this project and the [frontend project](https://github.com/GabrielEValenzuela/survivalMarket). Make sure to have both projects in the same directory, otherwise you will need to modify the relative paths of the docker compose file.
Then just run ```docker-compose up -d```. You're all set. :thumbsup: