gin_enhance

README

gin-enhance

gin 增强（包括swagger文档生成、自定义注解等）

项目说明：

• 通过注解增强，可实现类似java的控制器开发方式；
• 减少代码重复编写，提高开发效率；
• 一键生成swagger文档；
• 支持自定义注解 可通过自定义注解的方式，实现日志记录、权限控制等功能；

Documentation

Index

• func GetParamFromContext[T any](c *gin.Context, paramName string, dataType string, paramType string, ptr bool, ...) (value T, err error)
• func RegisterSwaggerDoc(app *gin.Engine, jsonPath string, route string)
• type ApiHandler
• type Config
• type ErrorWithCode

Functions

func GetParamFromContext

func GetParamFromContext[T any](c *gin.Context, paramName string, dataType string, paramType string, ptr bool, required bool) (value T, err error)

GetParamFromContext 从gin.Context中获取参数 c *gin.Context 上下文 paramName string 参数名 dataType string 数据类型 paramType string 参数类型 ptr bool 是否指针 required bool 是否必须

func RegisterSwaggerDoc

func RegisterSwaggerDoc(app *gin.Engine, jsonPath string, route string)

RegisterSwaggerDoc registers swagger documentation

app : the gin application

jsonPath: the path to the swagger json file (e.g. ./docs/swagger.json)

route: the path to register the swagger documentation (e.g. /doc)

return: the path of the swagger documentation

Types

type ApiHandler

type ApiHandler interface {
	// WrapContext 从gin.Context中获取context.Context
	WrapContext(c *gin.Context) context.Context

	// Success 成功返回
	// c *gin.Context 上下文
	// produceType string 返回类型
	// data interface{} 返回数据
	Success(c *gin.Context, produceType string, data interface{})

	// CodeError 失败返回
	// c *gin.Context 上下文
	// produceType string 返回类型
	// data interface{} 返回数据
	// code int 错误码
	// err error 错误
	CodeError(c *gin.Context, produceType string, data interface{}, code int, err error)

	// Error 失败返回
	// c *gin.Context 上下文
	// produceType string 返回类型
	// data interface{} 返回数据
	// err error 错误
	Error(c *gin.Context, produceType string, data interface{}, err error)

	// HandleCustomerAnnotation 处理自定义注解
	// c *gin.Context 上下文
	// annotation string 注解名
	// opt ...string 参数
	HandleCustomerAnnotation(c *gin.Context, annotation string, opt ...string) error
}

type Config

type Config struct {
	RelativePath string
	DocJson      string
}

type ErrorWithCode

type ErrorWithCode interface {
	error
	Code() int
}