A simple gin RESTful API template with following function.

• complete backend architecture
• use gorm build data model
• use logrus and other plugin to build logger service
• user swagger to generate docs and mock test
• simple user auth service with JWT
• simple test framework
• ci/cd example

--- pkg
 |------- common
 |------- controller
 |------- middleware
 |------- model
 |------- router
 |------- setting

• common
  • put tool which use in other service, ex. jwt, logger, etc.
• controller
  • accept input come from router
• middleware
  • some middleware, ex. logger, auth, etc.
• router
  • put all router here
• setting
  • convert enviroment value to CONFIG struct here

All env this project use, you can change default value in here.

This project use logrus + rotatelogs + lfshook to build log service.

• logrus use to instead of origin go logger
• rotatelogs use to split log file periodically
• lfshook is the logrus hook plugin, it will match log level to decide which log file should be write.

Not implement yet.

Not implement yet.

0. Initialize environment variable

cp env-sample .env

1. Start database

docker-compose up -d

2. Build service

It will build swagger document in ./docs at the same time, and u will get a executable file named app.

make build

3. Start service

./app

4. Result

You should be able to accept service by http://localhost:8080/health and accept swagger docs by http://localhost:8080/swagger/index.html.