Golang Food Data REST API
🚀
Development Setup
First of all create a new .env file in the root of the project directory. see example.env file for all required environment variables.
After setting up environment variables, run the following command to start development and database servers.
docker-compose up
before running this command you must have docker and docker-compose installed in your system.
Production
In order to deploy this application to production environment, create a docker image from Dockerfile and run it on your production server.
Technology
- Language (golang)
- Database (mysql)
Libraries
- Router (gorilla/mux)
- Server (net/http)
- JWT (dgrijalva/go-jwt)
- Password Encryption (bcrypt)
- Database ORM (gorm)
- Live Reload (cosmtrek/air)
Features
- Monlith
- Authentication
- endpoint protection with middleware
- Authorization - Role based Access Control (RBAC)
API Documentation
Authentication
POST
/auth/login
Login with username/email and password.
Body
{
"id": "abc123",
"password": "abc123",
}
Output
{
"jwt": "eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9.eyJzdWIiOiIxMjM0NTY3ODkwIiwibmFtZSI6IkpvaG4gRG9lIiwiaWF0IjoxNTE2MjM5MDIyfQ.SflKxwRJSMeKKF2QT4fwpMeJf36POk6yJV_adQssw5c",
"user": {
"id": "123e4567-e89b-12d3-a456-426614174000",
"name": "ABC 123",
"username": "abc123",
"email": "[email protected]",
}
}
POST
/auth/signup
Create a new user in the database.
Body
{
"name": "ABC 123",
"username": "abc123",
"email": "[email protected]",
"password": "abc123",
}
Output
{
"jwt": "eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9.eyJzdWIiOiIxMjM0NTY3ODkwIiwibmFtZSI6IkpvaG4gRG9lIiwiaWF0IjoxNTE2MjM5MDIyfQ.SflKxwRJSMeKKF2QT4fwpMeJf36POk6yJV_adQssw5c",
"user": {
"id": "123e4567-e89b-12d3-a456-426614174000",
"name": "ABC 123",
"username": "abc123",
"email": "[email protected]",
}
}
Data Manipulation
All endpoints are protected, must send valid jwt as Authorization header with each request.
GET
/food/all
Get All Food Items
Output
[
{
"id": "123e4567-e89b-12d3-a456-426614174000",
"name": "Apples",
"quantity": 100,
"selling_price": "100 USD",
},
{
"id": "123e4567-e89b-12d3-a456-426614174000",
"name": "Mangos",
"quantity": 97,
"selling_price": "120 USD",
}
]
GET
/food/
Get single Food Item by its name. name should be lowercase (e.g /food/apples)
Output
{
"id": "123e4567-e89b-12d3-a456-4265674174000",
"name": "Apples",
"quantity": 100,
"selling_price": "100 USD",
}
POST
/food
Add a new food item to the database.
Body
{
"name": "Oranges",
"quantity": 44,
"selling_price": "80 USD",
}
Output
{
"id": "123e4567-e89b-12d3-a456-426614174000",
"name": "Oranges",
"quantity": 44,
"selling_price": "80 USD",
}
DELETE
/food/
Delete one Food Item from the database.
Output
{
"id": "123e4567-e89b-12d3-a456-426614174000",
"name": "Oranges",
"quantity": 44,
"selling_price": "80 USD",
}
