syahidfrd/go-boilerplate

REST API boilerplate built with Go - Echo Framework

GO Boilerplate

Directory Structure

├── cmd
│   └── api             // Main applications for this project
├── config              // Configuration app
├── delivery            // Delivery usefull to encode raw body, query params, make a response to client
│   ├── http
│   └── middleware
├── docs                // Design and user documents (in addition to your godoc generated documentation)
├── domain              // Domains is a struct to store any objects from database, example you have a products in your tables.
├── infrastructure
│   └── datastore       // Database configuration
├── migration           // Database migrations.
├── mocks               // Mock code, generated by mockery
├── repository          // Represents the behavior of the data store. It can be implemented using PostgreSQL, MongoDB, etc
│   ├── pgsql
│   └── redis
├── transport           // Request and response model
│   └── request
├── usecase             // Usecase contains all of business logic
└── utils               // Additional services
    ├── crypto
    ├── jwt

Prerequisite and full list what has been used

• PostgreSQL - PostgreSQL Database
• Redis - Redis
• golang-migrate - Database migrations. CLI and Golang library
• echo - Web framework
• go-redis - Type-safe Redis client for Golang
• zerolog - Logger
• ozzo-validation - Go Struct and Field validation
• mockery - A mock code autogenerator for Golang
• swag - Generator RESTful API documentation with Swagger
• echo-swagger - Echo middleware for Swagger
• testify - A toolkit with common assertions and mocks
• godotenv - Environment variables loader

App requires 2 database (PostgreSQL and Redis server), run from your local machine or run it using docker with the following command

# run postgreSQL
docker run -d -p 5432:5432 -e POSTGRES_USER=postgres -e POSTGRES_PASSWORD=postgres -e POSTGRES_DB=go_boilerplate postgres

# run redis
docker run -d -p 6379:6379 redis

Migration

Run below command to run migration

migrate -path migration -database "${DATABASE_URL}" up

To create a new migration file

migrate create -ext sql -dir migration -seq name

Test

Run below command to run test, and make sure that all tests are passing

go test -v ./...

Running

Run below command to run app

go run ./cmd/api/main.go

Swagger URL

${BASE_URL}/swagger/index.html

You can find usefull commands in Makefile.

go-boilerplate's Issues

Add graceful Shutdown for High availability service

This boilerplate is very helpful for me to create go api projects without starting from scratch, but it would be nice if we implemented a graceful shutdown for the sake of the user, let's say the user is still in the middle of a request and we need to update our app or maybe our app crashes we can drain the connection first before shutting down.

i was tried to do long live request and send interruption signal then i got an error.

Spoiler :

My proposal :

adding graceful shitdown using go routine and channel just like in the echo docs https://echo.labstack.com/cookbook/graceful-shutdown/

package main

/* folded code */

func main() {
      
       /* folded code */

       
	// Setup route engine & middleware
	e := echo.New()
	e.Use(middleware.CORS())
	e.Use(appMiddleware.RequestID())
	e.Use(appMiddleware.Logger())
	e.Use(middleware.Recover())

	// Setup handler
	e.GET("/swagger/*", echoSwagger.WrapHandler)
	e.GET("/", func(c echo.Context) error {
		return c.String(http.StatusOK, "i am alive")
	})

	httpDelivery.NewTodoHandler(e, appMiddleware, todoUC)
	httpDelivery.NewAuthHandler(e, appMiddleware, authUC)

       // gracefull shutdown
       	go func() {
		if err := e.Start(fmt.Sprintf(":%s", configApp.ServerPORT)); err != nil && err != http.ErrServerClosed {
			e.Logger.Fatal("shutting down the server")
		}
	}()

        quit := make(chan os.Signal, 1)
	signal.Notify(quit, os.Interrupt)
	<-quit
	ctx, cancel := context.WithTimeout(context.Background(), 10*time.Second)
	defer cancel()
	if err := e.Shutdown(ctx); err != nil {
		e.Logger.Fatal(err)
	}

}

it would be nice if you assign this issue to me because i'm gabut

gorm

Hi, thanks for this boilerplate. I use it in my project. Do you think add gorm package to go-boilerplate?

openapi3 and swaggo

I was able to get swagger docs served via echo server. One question, your jwt stuff uses uid and password for authentication. Is it possible to change to bearer auth tokens for authentication?

Future plans

Are you planning to add user signup and JWT auth to your boilerplate?

how to do you run migrate command?