zdpgo_api

README

zdpgo_api

基于gin二次封装的一个后端api快速开发框架

项目地址：https://github.com/zhangdapeng520/zdpgo_api

版本历史

• v1.0.0 2022/02/09
• v1.0.1 2022/02/11 指定默认模板目录template和默认静态文件夹目录static
• v1.0.2 2022/02/11 移除本地依赖
• v1.0.3 2022/02/11 新增日志中间件和recover中间件
• v1.0.4 2022/03/08 优化模板和静态目录
• v1.0.5 2022/03/08 增加常用的统一返回对象
• v1.0.6 2022/03/08 将挂载通用路由设置为开关量
• v1.0.7 2022/03/10 支持配置服务相关参数
• v1.0.8 2022/03/10 支持viper读取和设置配置
• v1.0.9 2022/03/11 logger日志支持配置
• v1.1.0 2022/03/12 修复日志不打印body
• v1.1.1 2022/04/08 新增详细日志
• v1.1.2 2022/04/11 详细日志升级，支持查看的具体Body中的JSON数据
• v1.1.3 2022/04/21 文件上传
• v1.1.4 2022/05/16 新增：Api核心对象
• v1.1.5 2022/05/17 优化：日志中间件优化
• v1.1.6 2022/05/17 新增：添加静态文件服务
• v1.1.7 2022/05/17 新增：API分组
• v1.1.8 2022/06/06 新增：读取ECC加密的JSON数据
• v1.1.9 2022/06/11 新增：读取ECC加密的文本数据
• v1.2.0 2022/06/11 新增：读取AES加密的数据
• v1.2.1 2022/06/14 优化：上传文件接口优化
• v1.2.2 2022/06/15 优化：日志优化
• v1.2.3 2022/06/20 优化：日志优化
• v1.2.4 2022/06/27 新增：健康检查和接口限流
• v1.2.5 2022/06/29 新增：密码组件升级
• v1.2.6 2022/07/08 升级：升级password组件

使用示例

请查看 examples 目录

Documentation

Index

• Constants
• Variables
• func SetLog(log *zdpgo_log.Log)
• type Api
  • func New(log *zdpgo_log.Log) *Api
  • func NewWithConfig(config *Config, log *zdpgo_log.Log) *Api
  • func (a *Api) AddCorsMiddleware()
  • func (a *Api) AddHealthCheckRouter()
  • func (a *Api) AddRateLimitMiddleware()
  • func (a *Api) AddStaticFSRouter(routerPath string, fsObj fs.FS)
  • func (a *Api) AddStaticRouter(routerPath string, dirPath string)
  • func (a *Api) AddUploadRouter(routerPath string, fileName string, saveDir string, ...)
  • func (a *Api) Any(method, routerPath string, handleFuncList ...func(ctx *Context))
  • func (a *Api) CreateDirs(filePath string) error
  • func (a *Api) Delete(routerPath string, handleFuncList ...func(ctx *Context))
  • func (a *Api) Get(routerPath string, handleFuncList ...func(ctx *Context))
  • func (a *Api) GetBasicAuthGroup(routerPath string, accounts StringMap) (group *ApiGroup)
  • func (a *Api) GetMd5(data string) string
  • func (a *Api) InitValidator() (err error)
  • func (a *Api) IsExists(path string) bool
  • func (a *Api) Patch(routerPath string, handleFuncList ...func(ctx *Context))
  • func (a *Api) Post(routerPath string, handleFuncList ...func(ctx *Context))
  • func (a *Api) Put(routerPath string, handleFuncList ...func(ctx *Context))
  • func (a *Api) Run(exitFuncList ...func())
  • func (a *Api) SetApp(app *gin.Engine)
  • func (a *Api) SetLog(log *zdpgo_log.Log)
  • func (a *Api) Validate(data interface{}) (errData map[string]string)
• type ApiGroup
  • func (g *ApiGroup) Any(method, routerPath string, handleFuncList ...func(ctx *Context))
  • func (g *ApiGroup) Delete(routerPath string, handleFuncList ...func(ctx *Context))
  • func (g *ApiGroup) Get(routerPath string, handleFuncList ...func(ctx *Context))
  • func (g *ApiGroup) Patch(routerPath string, handleFuncList ...func(ctx *Context))
  • func (g *ApiGroup) Post(routerPath string, handleFuncList ...func(ctx *Context))
  • func (g *ApiGroup) Put(routerPath string, handleFuncList ...func(ctx *Context))
• type Config
• type Context
  • func (c *Context) GetAesTextBodyToJson(jsonData interface{}) error
  • func (c *Context) GetBody() ([]byte, error)
  • func (c *Context) GetResponseSuccess(data interface{}) Response
  • func (c *Context) ResponseAesStr(jsonResponse interface{})
• type JsonMap
• type MiddlewareConfig
• type Response
• type RouterConfig
• type StringMap

Constants

const (
	AuthUserKey = "user" // 是基本身份验证中用户凭据的cookie名称。
)

Variables

var (
	Password *zdpgo_password.Password
	Log      *zdpgo_log.Log
)

Functions

func SetLog

func SetLog(log *zdpgo_log.Log)

SetLog 设置日志

Types

type Api

type Api struct {
	Config *Config     // 配置对象
	App    *gin.Engine // 核心App对象
}

Api API核心对象

func New

func New(log *zdpgo_log.Log) *Api

New 使用默认配置创建API

func NewWithConfig

func NewWithConfig(config *Config, log *zdpgo_log.Log) *Api

NewWithConfig 根据配置创建API

func (*Api) AddCorsMiddleware

func (a *Api) AddCorsMiddleware()

AddCorsMiddleware 添加跨域中间件

func (*Api) AddHealthCheckRouter

func (a *Api) AddHealthCheckRouter()

AddHealthCheckRouter 添加健康检查接口

func (*Api) AddRateLimitMiddleware

func (a *Api) AddRateLimitMiddleware()

AddRateLimitMiddleware 添加请求速率中间件

func (*Api) AddStaticFSRouter

func (a *Api) AddStaticFSRouter(routerPath string, fsObj fs.FS)

AddStaticFSRouter 添加嵌入式文件系统作为静态目录

func (*Api) AddStaticRouter

func (a *Api) AddStaticRouter(routerPath string, dirPath string)

AddStaticRouter 添加静态文件目录

func (*Api) AddUploadRouter

func (a *Api) AddUploadRouter(
	routerPath string,
	fileName string,
	saveDir string,
	handleResultList ...func(c *Context, file *multipart.FileHeader, err error))

AddUploadRouter 添加文件上传路由 @param routerPath 路由路径，比如：/upload @param fileName 上传文件的表单名称，比如：file @param saveDir 文件的上传路径，比如：./uploads @param handleResultList 处理结果的方法列表，用户可以自定义文件上传后的返回内容，处理错误信息

func (*Api) Any

func (a *Api) Any(method, routerPath string, handleFuncList ...func(ctx *Context))

Any 处理任意方法类型

func (*Api) CreateDirs

func (a *Api) CreateDirs(filePath string) error

CreateDirs 调用os.MkdirAll递归创建文件夹

func (*Api) Delete

func (a *Api) Delete(routerPath string, handleFuncList ...func(ctx *Context))

Delete 处理DELETE方法类型

func (*Api) Get

func (a *Api) Get(routerPath string, handleFuncList ...func(ctx *Context))

Get 处理GET方法类型

func (*Api) GetBasicAuthGroup

func (a *Api) GetBasicAuthGroup(routerPath string, accounts StringMap) (group *ApiGroup)

GetBasicAuthGroup 获取基本权限校验路由组

func (*Api) GetMd5

func (a *Api) GetMd5(data string) string

GetMd5 获取MD5值

func (*Api) InitValidator

func (a *Api) InitValidator() (err error)

InitValidator 初始化校验器

func (*Api) IsExists

func (a *Api) IsExists(path string) bool

IsExists 判断所给路径文件/文件夹是否存在(返回true是存在)

func (*Api) Patch

func (a *Api) Patch(routerPath string, handleFuncList ...func(ctx *Context))

Patch 处理PATCH方法类型

func (*Api) Post

func (a *Api) Post(routerPath string, handleFuncList ...func(ctx *Context))

Post 处理POST方法类型

func (*Api) Put

func (a *Api) Put(routerPath string, handleFuncList ...func(ctx *Context))

Put 处理PUT方法类型

func (*Api) Run

func (a *Api) Run(exitFuncList ...func())

TODO: 自动重启https://www.codeleading.com/article/97834445692/ Run 运行APP

func (*Api) SetApp

func (a *Api) SetApp(app *gin.Engine)

SetApp 设置APP

func (*Api) SetLog

func (a *Api) SetLog(log *zdpgo_log.Log)

SetLog 设置日志

func (*Api) Validate

func (a *Api) Validate(data interface{}) (errData map[string]string)

Validate 校验结构体

type ApiGroup

type ApiGroup struct {
	gin.RouterGroup
}

ApiGroup API分组

func (*ApiGroup) Any

func (g *ApiGroup) Any(method, routerPath string, handleFuncList ...func(ctx *Context))

func (*ApiGroup) Delete

func (g *ApiGroup) Delete(routerPath string, handleFuncList ...func(ctx *Context))

Delete 处理DELETE方法类型

func (*ApiGroup) Get

func (g *ApiGroup) Get(routerPath string, handleFuncList ...func(ctx *Context))

Get 处理GET方法类型

func (*ApiGroup) Patch

func (g *ApiGroup) Patch(routerPath string, handleFuncList ...func(ctx *Context))

Patch 处理PATCH方法类型

func (*ApiGroup) Post

func (g *ApiGroup) Post(routerPath string, handleFuncList ...func(ctx *Context))

Post 处理POST方法类型

func (*ApiGroup) Put

func (g *ApiGroup) Put(routerPath string, handleFuncList ...func(ctx *Context))

Put 处理PUT方法类型

type Config

type Config struct {
	Debug          bool             `yaml:"debug" json:"debug"`
	Host           string           `yaml:"host" json:"host"`                         // 启动地址，默认0.0.0.0
	Port           int              `yaml:"port" json:"port"`                         // 启动端口号，默认3333
	UploadFileSize int64            `yaml:"upload_file_size" json:"upload_file_size"` // 上传文件大小限制（M），默认33
	RateLimit      uint64           `yaml:"rate_limit" json:"rate_limit"`             // 请求速率，默认3333
	Middleware     MiddlewareConfig `yaml:"middleware" json:"middleware"`             // 中间件
	Router         RouterConfig     `yaml:"router" json:"router"`                     // 路由配置
}

type Context

type Context struct {
	gin.Context
}

Context 重命名gin上下文

func (*Context) GetAesTextBodyToJson

func (c *Context) GetAesTextBodyToJson(jsonData interface{}) error

func (*Context) GetBody

func (c *Context) GetBody() ([]byte, error)

GetBody 获取body中的字符串数据

func (*Context) GetResponseSuccess

func (c *Context) GetResponseSuccess(data interface{}) Response

获取成功的响应

func (*Context) ResponseAesStr

func (c *Context) ResponseAesStr(jsonResponse interface{})

type JsonMap

type JsonMap map[string]interface{}

JsonMap json字典类型

type MiddlewareConfig

type MiddlewareConfig struct {
	Cors      bool `yaml:"cors" json:"cors"`
	RateLimit bool `yaml:"rateLimit" json:"rateLimit"`
}

type Response

type Response struct {
	Code   int         `json:"code"`
	Msg    string      `json:"msg"`
	Status bool        `json:"status"`
	Data   interface{} `json:"data"`
}

type RouterConfig

type RouterConfig struct {
	HealthCheck bool `yaml:"health_check" json:"health_check"`
}

type StringMap

type StringMap map[string]string

StringMap 字符串类型的字典