go-fiber-template

This is a Web API application template based on Fiber. This template includes Wire and Swagger, allowing you to quickly develop Web API applications.

Setup

Install Go-Wire

To install Go-Wire, run the following command:

go install github.com/google/wire/cmd/wire@latest
go mod tidy # This command is used to update the go.mod file

Install swag

Since this project template uses Swagger to automatically generate API documents, you need to install swag before using it. You can use the following command to install swag:

go install github.com/swaggo/swag/cmd/swag@latest

Install gofiber-swagger

Since this project template uses the Swagger middleware of Fiber to provide Swagger UI, you need to install go-fiber-swagger before using it. You can use the following command to install go-fiber-swagger:

go get -u github.com/gofiber/swagger

How dependencies injection works in this template

This project uses Wire to manage dependencies. You can use the following command to generate the dependency injection code:

In the wire.go file, we can see that three WireSets are defined, namely repoSet, serviceSet, routesSet, which respectively define the dependency relationship of the Repository layer, Service layer, and Route layer.

It is worth noting that the route layer in this project defines an interface to describe the routing configuration for FiberApp. All routing configurations must implement this interface.

type FiberRouter interface {
	ConfigureRoutes(app *fiber.App)
}


type PostRouter struct {
    _postService *services.PostService
}

// The PostRouter requires a PostService object to be injected into the constructor.
func NewPostRouter(postService *services.PostService) *PostRouter {
	return &PostRouter{
        _postService: postService,
    }
}

After defining the routing configuration, you can add the objects you need to Dependency injection in the constructor of the Route type.

var routesSet = wire.NewSet(
	routes.NewNewsRouter,
	routes.NewPostRouter, // Add the Router object to the dependency injection set
	
	AssembleFiberRouters,
)

// This method is used to assemble all routing configurations and return a list of FiberRouters.
// This list will be used in main.go to configure the routes of FiberApp.
func AssembleFiberRouters(
	newsRouter *routes.NewsRouter, 
	postRouter *routes.PostRouter, // Inject the Router object into the AssembleFiberRouters method
) []routes.FiberRouter {
	return []routes.FiberRouter{newsRouter, postRouter}
}

This AssembleFiberRouters method is used to assemble all routing configurations and return a list of FiberRouters. This list will be used in main.go to configure the routes of FiberApp.

The dependency injection relationship diagram of the entire project is as follows: