🔥 Golang Rest Api with basic JWT Authentication and Basic Crud Operations.

Junaid Javed

Last update: Oct 4, 2022

Related tags

Authentication & OAuth go-rest-api

Overview

Golang Food Data REST API 🚀

🔥 Golang Rest Api with basic JWT Authentication and Basic Crud Operations.

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

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",
}

You might also like...

A simple passwordless authentication middleware that uses only email as the authentication provider

email auth A simple passwordless authentication middleware that uses only email as the authentication provider. Motivation I wanted to restrict access

5 Jul 27, 2022

Basic and Digest HTTP Authentication for golang http

HTTP Authentication implementation in Go This is an implementation of HTTP Basic and HTTP Digest authentication in Go language. It is designed as a si

529 Dec 22, 2022

X3 - A template for using HTTP Basic Authentication in Go

HTTP Basic Auth in Go This is a template for using HTTP Basic Auth in a Go appli

92 Sep 28, 2022

Goauth - Basic username password cookie based authentication with Go Lang

goauth [WIP] Basic username password cookie based authentication with Go Lang Overview Use a Postgres DB to store Sign-in and Sign-up info Redis for c