在 Go 应用中像 FastAPI 一样优雅地构建控制器

在 Python 中，FastAPI 凭借其自动请求解析、数据验证和类型提示等强大功能，成为了构建 API 的热门框架。然而，在 Go 语言中，却鲜少有框架能够提供类似的便捷体验。开发者往往需要在每个 API 处理程序中重复编写相同的解析和错误处理逻辑，这无疑增加了代码的冗余度和维护成本。

go-rest-kit 的出现正是为了解决这一痛点。它提供了一套现成的包，可以帮助开发者快速构建基于 Gin 框架的 RESTful API，并通过类似 FastAPI 的方式定义控制器，从而避免重复编写繁琐的代码。

go-rest-kit 的设计理念

go-rest-kit 的核心目标是简化 Go 应用中 REST API 的开发流程，其设计理念主要体现在以下几个方面：

自动请求解析和验证: go-rest-kit 利用 Go 的类型系统和结构体标签，实现了类似 FastAPI 的自动请求解析和验证功能。开发者只需定义好请求和响应的数据结构，并添加相应的标签，即可自动完成数据的绑定和校验。
控制器方法: go-rest-kit 提供了一系列预定义的控制器方法，例如 Create、Retrieve、Update、Delete 等，涵盖了常见的 CRUD 操作。开发者只需将这些方法与路由绑定，即可快速构建 API 接口。
可扩展性: go-rest-kit 的各个组件都设计为可插拔的，开发者可以根据自身需求，替换或扩展默认的实现。例如，可以使用自定义的数据库访问层、身份验证机制等。

快速上手

安装

go get github.com/krsoninikhil/go-rest-kit

示例：构建 CRUD API

以下示例演示了如何使用 go-rest-kit 构建一个简单的 CRUD API：

// models.go
package models

import (
 "fmt"

 "github.com/krsoninikhil/go-rest-kit/pgdb"
)

// BusinessType represents a business type entity.
type BusinessType struct {
 Name string `json:"name"`
 Icon string `json:"icon"`
 pgdb.BaseModel
}

// ResourceName returns the resource name of the BusinessType model.
func (b BusinessType) ResourceName() string {
 return fmt.Sprintf("%T", b)
}

// entities.go
package types

// BusinessTypeRequest represents the request payload for creating or updating a business type.
type BusinessTypeRequest struct {
 Name string `json:"name" binding:"required"`
 Icon string `json:"icon"`
}

// BusinessTypeResponse represents the response payload for a business type.
type BusinessTypeResponse struct {
 BusinessTypeRequest
 ID int `json:"id"`
}

// ToModel converts a BusinessTypeRequest to a BusinessType model.
func (b BusinessTypeRequest) ToModel(_ *gin.Context) models.BusinessType {
 return models.BusinessType{Name: b.Name, Icon: b.Icon}
}

// FillFromModel fills a BusinessTypeResponse with data from a BusinessType model.
func (b BusinessTypeResponse) FillFromModel(m models.BusinessType) crud.Response[models.BusinessType] {
 return BusinessTypeResponse{
  ID:               m.ID,
  BusinessTypeRequest: BusinessTypeRequest{Name: m.Name, Icon: m.Icon},
 }
}

// ItemID returns the ID of the business type.
func (b BusinessTypeResponse) ItemID() int { return b.ID }

// main.go
package main

import (
 "fmt"

 "github.com/gin-gonic/gin"
 "github.com/krsoninikhil/go-rest-kit/crud"
 "github.com/krsoninikhil/go-rest-kit/request"
)

func main() {
 // Assuming you have a database connection `db` and a business type DAO `businessTypeDao`
 businessTypeDao := crud.Dao[models.BusinessType]{PGDB: db}
 businessTypeCtlr := crud.Controller[models.BusinessType, types.BusinessTypeResponse, types.BusinessTypeRequest]{
  Svc: &businessTypeDao,
 }

 r := gin.Default()
 r.GET("/business-types", request.BindGet(businessTypeCtlr.Retrieve))
 r.GET("/business-types", request.BindGet(businessTypeCtlr.List))
 r.POST("/business-types", request.BindCreate(businessTypeCtlr.Create))
 r.PATCH("/business-types", request.BindUpdate(businessTypeCtlr.Update))
 r.DELETE("/business-types", request.BindDelete(businessTypeCtlr.Delete))

 // Start your server
}

在上面的示例中，我们首先定义了 BusinessType 模型、BusinessTypeRequest 请求结构体和 BusinessTypeResponse 响应结构体。然后，我们创建了一个 crud.Controller 实例，并将 businessTypeDao 作为服务注入其中。最后，我们使用 request 包提供的绑定方法将控制器方法与路由绑定起来。

示例：加载应用程序配置

go-rest-kit 提供了便捷的配置加载机制，支持从 YAML 文件和环境变量中读取配置信息。

// config.go
package config

import (
 "fmt"

 "github.com/krsoninikhil/go-rest-kit/auth"
 "github.com/krsoninikhil/go-rest-kit/pgdb"
 "github.com/krsoninikhil/go-rest-kit/twilio"
)

// Config defines the application configuration structure.
type Config struct {
 DB     pgdb.Config
 Twilio twilio.Config
 Auth   auth.Config
 Env    string
}

// EnvPath returns the path to the .env file.
func (c *Config) EnvPath() string { return "./.env" }

// SourcePath returns the path to the YAML configuration file.
func (c *Config) SourcePath() string { return fmt.Sprintf("./api/%s.yml", c.Env) }

// SetEnv sets the environment for the configuration.
func (c *Config) SetEnv(env string) { c.Env = env }

// main.go
package main

import (
 "context"

 "github.com/krsoninikhil/go-rest-kit/config"
)

func main() {
 var (
  ctx  = context.Background()
  conf Config
 )

 config.Load(ctx, &conf)

 // Use the loaded configuration
 db := pgdb.NewPGConnection(ctx, conf.DB)
 // ...
}

在上面的示例中，我们定义了 Config 结构体，并实现了 config.AppConfig 接口。然后，我们使用 config.Load 方法加载配置信息。

核心包详解

go-rest-kit 包含以下核心包：

request: 提供基于请求类型的参数绑定功能，允许控制器方法直接接收解析后的请求参数和请求体，避免在每个控制器中重复编写解析逻辑。
crud: 提供用于常见 CRUD 操作的控制器，例如 crud.Controller 和 crud.NestedController。
apperrors: 提供应用程序中常用的错误类型，例如 apperrors.NewServerError、apperrors.NewNotFoundError 等。
config: 提供快速加载和解析配置文件的方法，支持从 YAML 文件和环境变量中读取配置信息。
pgdb: 提供 PostgreSQL 数据库连接配置和创建方法。
integrations: 提供常用的第三方客户端，例如 Twilio 客户端，用于发送 OTP 短信验证码。
auth: 提供与身份验证相关的功能，例如注册、登录、OTP 验证、令牌刷新等。