medani17 / go-rest-api

GO-REST-API

Hello, I have created a simple Go project that uses Gofr, Gorm, and MySQL.

This project aims to create REST APIs for basic operations, including create, read, update, and delete. I have create simple example involving a student management using these operations to illustrate the use case.

This project can be consider for future modification for learning purpose where i can add more feature for a student such as subjects a student can have.

To test this project i have created a database locally using mysql cli with the following commands:

1. create database students;

2. use database students;

3. CREATE TABLE students ( id INT PRIMARY KEY, name VARCHAR(255), class VARCHAR(50), age INT );

4. After that i have used create API and generated students records.

Application Requirement

1. Install Go version - 1.21.5 via

• https://go.dev/doc/install

2. Once installed, Please check via below command

    go version

3. Install GoFr

    go get gofr.dev

Setup Project

1. Clone the Project

   git clone <project_url>
   cd <project_directory>

2. Install Dependencies (Make sure that Go and MySQL are installed on your computer)

     go mod tidy

4. Create a Local MySQL Database

   mysql -u root -p

4. Run the Program

   go run main.go

5. Test with Postman

⚙Project-Structure and Setup

HTTP-Rest-API/
    ├── configs/
    │     └── .env
    │
    ├── handler/
    │     └── handler.go
    │
    ├── model/
    │     └── model.go
    │
    ├── datastore/
    │     ├── datastore.go
    │     └── interface.go
    │── test
    │    ├── datastore_test.go
    │    ├── handler_test.go
    |                 
    ├── main.go
    ├── go.mod

After our project is succesfully built we have run it with the command go run main.go and it then pops the result of successfully connected to the database.

Unit Test

Then we have used postman and tested different apis that we have made, and got the output similar to the attached images below:

Diagrams

1. Architecture Diagram
2. Sequence Diagram