BoomNooB / SimpleGoCRUD

Using go with gin and gorm to create a simple sql restful and also with unit test

Simple Go CRUD

TechStack

• GIN
• GORM (SQLite)

Table of Contents

• Installation
• API Endpoints
  • Readiness Check
  • Create Customer
  • Update Customer
  • Get Customer by ID
  • Delete Customer
• Running Unit Tests

Installation

To get started, follow these steps:

1. Clone the Repository:

   git clone https://github.com/BoomNooB/SimpleGoCRUD.git
   cd SimpleGoCRUD
   

2. Install Dependencies:
   Ensure you have Go installed. Then, run the following command to install the project's dependencies:
   go mod tidy

3. Running a makefile:
   Simply just run make then it will do a couple of thing here

   • Create a .env file in the root directory and set the API_PORT variable to 22345 the port on which the API will run:
   • Initialize the SQLite database and put 20 example of customer info into database that name customer.db
   • Copy .env and customer.db to ./api

4. Run the Application:
   Start the server by executing: go run cmd/main/main.go
   or you can run with air (I've already provide the air config file) The server will start at http://localhost:22345

API Endpoints

Readiness Check

Check if the API is running.

• URL: /
• Method: GET
• Response:
  • Status Code: 200 OK
  • Body:

    {
      "data": "API is running"
    }

Create Customer

Create a new customer.

• URL: /customers
• Method: POST
• Request Body:

  {
    "name": "New Customer",
    "age": 25
  }

• Response:
  • Status Code: 201 Created
  • Body:

    {
      "id": 2,
      "name": "New Customer",
      "age": 25
    }

Update Customer

Update customer information by ID.

• URL: /customers/:id
• Method: PUT
• URL Parameters:
  • id (uint, required) - The ID of the customer to update.
• Request Body:

  {
    "name": "Updated Customer",
    "age": 30
  }

• Response:
  • Status Code: 200 OK
  • Body:

    {
      "id": 1,
      "name": "Updated Customer",
      "age": 30
    }

Get Customer by ID

Retrieve customer information by ID.

• URL: /customers/:id
• Method: GET
• URL Parameters:
  • id (uint, required) - The ID of the customer to retrieve.
• Response:
  • Status Code: 200 OK
  • Body:

    {
      "id": 1,
      "name": "John Doe",
      "age": 30
    }

Delete Customer

Delete a customer by ID.

• URL: /customers/:id
• Method: DELETE
• URL Parameters:
  • id (uint, required) - The ID of the customer to delete.
• Response:
  • Status Code: 200 OK

Running Unit Tests

Assume that you've run the makefile since installation step Before running the test please ensure that the variable record_id contains an existing ID from the database in the test file api/customer_test.go

• Run the tests using the following command: go test ./... or go test ./... -cover if you want to see percent of coverage

The test coverage of this suite is 83.3%.

---