Create REST API With Gin Framework And Golang

Project Structure

Configuration Setup

To implement APIs we just need to import the gin library and along with that we also need to add an HTTP package in the same file.

Let's create an Employee model in the main.go file and define the JSON structure for each of the elements in it.

type Employee struct {
	EmployeeId   string `json:"employeeid"`
	EmployeeName string `json:"employeename"`
	Company      string `json:"company"`
	Salary       int    `json:"salary"`
}

Since We are not pointing to any database in this project and here i am mocking the response object for the employees to test the API response.

var employees = [] Employee {
    {
        EmployeeId: "001",
        EmployeeName: "Jay",
        Company: "Xyz",
        Salary: 2400,
    }, {
        EmployeeId: "002",
        EmployeeName: "Krishna",
        Company: "zey",
        Salary: 2800,
    }, {
        EmployeeId: "003",
        EmployeeName: "Reddy",
        Company: "zwd",
        Salary: 3400,
    },
}

As mentioned earlier, the Gin package handles the HTTP routing for this particular project. This means that any kind of HTTP request sent to the Golang API Server will be routed to the appropriate method handlers.

Open up the main.go file and add the following function. This basically takes care of all routing concerns related to Employees.

Implementing Get API

Next, Get Employee all the details. For this firstly we will need to have a function that will fetch the data but here in our case, we suppose to get the mock response.

func createEmployee(c *gin.Context) {
	var newEmployee Employee
	if err := c.BindJSON(&newEmployee); err != nil {
		return
	}
}

Below are the complete changes that we can see in the main.go file.

main.go

package main

import("net/http"
    "github.com/gin-gonic/gin")
type Employee struct {
    EmployeeId string `json:"employeeid"`
    EmployeeName string `json:"employeename"`
    Company string `json:"company"`
    Salary int `json:"salary"`
}
var employees = [] Employee {
    {
        EmployeeId: "001",
        EmployeeName: "Jay",
        Company: "Xyz",
        Salary: 2400,
    }, {
        EmployeeId: "002",
        EmployeeName: "Krishna",
        Company: "zey",
        Salary: 2800,
    }, {
        EmployeeId: "003",
        EmployeeName: "Reddy",
        Company: "zwd",
        Salary: 3400,
    },
}
// Fetch all Employes Data
func getEmployees(c * gin.Context) {
    c.IndentedJSON(http.StatusOK, employees)
}
// Create Employee with Data
func createEmployee(c * gin.Context) {
    var newEmployee Employee
    if err: = c.BindJSON( & newEmployee);
    err != nil {
        return
    }
}
func main() {
    router: = gin.Default()
    router.GET("/employees", getEmployees)
    router.POST("/employees", createEmployee)
    router.Run("localhost:8080")
}

Testing the Output

To run and test our Get API we just need to run the project on the defined port number which is localhost:8080, Run the below command

-- go run main.go

Here I am using Thunder Client vs code extension which is pretty simple to use as an extension that exists within our ide.

Open the thunder client extension and paste the GetEmployee API Url and hit the send button. On the next right-hand side, you can see the status code with the API success response.

Source Code - Click here

Conclusion

Thank you for reading, I hope this article gives you a brief idea about Rest API implementation with Go lang and GIN framework with code samples.

Please let me know your questions, thoughts, or feedback in the comments section. I appreciate your feedback and encouragement.

Keep learning ...!