Golang Service Template
Golang back-end service template. Using this template, you can get started with back-end projects quickly.
| Web Framework | ORM | Database Driver | Configuration Manager | Log Manager | API Documentation |
|---|---|---|---|---|---|
| labstack/echo/v4 | gorm.io/gorm | gorm.io/driver/mysql | spf13/viper | sirupsen/logrus | swaggo/echo-swagger |
Configuration
- Create database and user in MySQL, and grant privileges to user.
CREATE DATABASE buz;
CREATE USER 'foo'@'localhost' IDENTIFIED BY 'bar';
GRANT ALL PRIVILEGES ON buz.* TO 'foo'@'localhost';
- Create a file named
conf.yamlin the project's root directory.
sql:
username: foo
password: bar
db_name: buz
- To generate API doc, you need to execute the following commands:
go install github.com/swaggo/swag/cmd/swag@latest # download swag, a doc generator
swag init # docs will be written into `docs/` directory
- Compile and run this project. You will find API doc in
http://localhost:1323/api/doc/index.htmlon default. - Change the go module name of this project to whatever you like.
Usage
- To create tables, add structs in
model/.model/foo.gois an example of such struct. Then, add the struct toDB.AutoMigrateinmodel/init.go. - Add business logics in
controller/, then add router incontroller/routers.go. - Write API doc alongside with the controller function.
controller/foo.gois an example.
