There is no doubt that Golang’s good documentation and intelligent features could help developers in learning language efficiently and outcome might be promising still, What Golang is missing is the common structure to quick start any API Structure. While working on several Golang Projects, Golang Developers at Mindinventory confront the requirement of having an effective and well Integrated GoLang API Development Structure and as a result of which they came up with one.
- gorm : It is the ORM library in Go which provides user friendly functions to interact with database. It supports features like ORM, Associations, Hooks, Preloading, Transaction, Auto Migration, Logger etc.
- gin : Gin is a web framework for Go language. Here gin is used for increase performance and productivity.
- godotenv : Basically used for load env variables from .env file.
- mysql : It provides the mysql driver for connecting Go with MySQL.
Check out our blog to know how to use Golang API Skeleton with Fully Managed Versions to kick start Golang project. (https://www.mindinventory.com/blog/golang-project-structure/)
It is a fully managed repository, where one can find all required components in a single package including versioning for REST APIs and you do not need to set up each time they start with any crucial work in Golang.
One need to install the latest version of Go i.e 1.12 (Released in Feb 2019) from https://golang.org/dl/ and setup GOROOT and GOPATH.
Basically contains the helper functions used in returning api responses, HTTP status codes, default messages etc.
Contains handler functions for particular route to be called when an api is called.
Contains helper functions used in all apis
Middleware to be used for the project
Database tables to be used as models struct
Resources contains all structures other than models which can be used as responses
Resources define the routes for your project
It is optional, but if you want to insert lots of dummy records in your database, then you can use seeder.
All the core apis for your projects should be within services.
It is generally for storage purpose.
Contains the HTML templates used in your project
Contains environment variables.
. For running the server you have to run following command in the terminal.
go run main.go
It will start your server at the port you have mentioned in the .env file.
. To run the server in a port other than the default, run following command.
go run main.go <specific port>
. To create a build for your project and uploaded in the server, one need to run following command.
go build
127.0.0.1:8099/api/v1/user-list
127.0.0.1:8099/api/v2/user-list
Go Project Structure is MIT-licensed
We’d be really happy if you sent us links to your projects where you use our component. Just send an email to sallamy2580@gmail.com And do let us know if you have any questions or suggestion regarding our work.