ginplus

Documentation

Index

• Constants
• func GetPageIndex(c *gin.Context) int
• func GetPageSize(c *gin.Context) int
• func GetPaginationParam(c *gin.Context) *schema.PaginationParam
• func GetToken(c *gin.Context) string
• func GetTraceID(c *gin.Context) string
• func GetUserID(c *gin.Context) string
• func NewContext(c *gin.Context) context.Context
• func ParseForm(c *gin.Context, obj interface{}) error
• func ParseJSON(c *gin.Context, obj interface{}) error
• func ParseQuery(c *gin.Context, obj interface{}) error
• func ResError(c *gin.Context, err error, status ...int)
• func ResJSON(c *gin.Context, status int, v interface{})
• func ResList(c *gin.Context, v interface{})
• func ResOK(c *gin.Context)
• func ResPage(c *gin.Context, v interface{}, pr *schema.PaginationResult)
• func ResSuccess(c *gin.Context, v interface{})
• func SetUserID(c *gin.Context, userID string)

Constants

const (

	// UserIDKey 存储上下文中的键(用户ID)
	UserIDKey = prefix + "/user-id"
	// TraceIDKey 存储上下文中的键(跟踪ID)
	TraceIDKey = prefix + "/trace-id"
	// ResBodyKey 存储上下文中的键(响应Body数据)
	ResBodyKey = prefix + "/res-body"
)

定义上下文中的键

Functions

func GetPageIndex

func GetPageIndex(c *gin.Context) int

GetPageIndex 获取分页的页索引

func GetPageSize

func GetPageSize(c *gin.Context) int

GetPageSize 获取分页的页大小(最大50)

func GetPaginationParam

func GetPaginationParam(c *gin.Context) *schema.PaginationParam

GetPaginationParam 获取分页查询参数

func GetToken

func GetToken(c *gin.Context) string

GetToken 获取用户令牌

func GetTraceID

func GetTraceID(c *gin.Context) string

GetTraceID 获取追踪ID

func GetUserID

func GetUserID(c *gin.Context) string

GetUserID 获取用户ID

func NewContext

func NewContext(c *gin.Context) context.Context

NewContext 封装上下文入口

func ParseForm

func ParseForm(c *gin.Context, obj interface{}) error

ParseForm 解析Form请求

func ParseJSON

func ParseJSON(c *gin.Context, obj interface{}) error

ParseJSON 解析请求JSON

func ParseQuery

func ParseQuery(c *gin.Context, obj interface{}) error

ParseQuery 解析Query参数

func ResError

func ResError(c *gin.Context, err error, status ...int)

ResError 响应错误

func ResJSON

func ResJSON(c *gin.Context, status int, v interface{})

ResJSON 响应JSON数据

func ResList

func ResList(c *gin.Context, v interface{})

ResList 响应列表数据

func ResOK

func ResOK(c *gin.Context)

ResOK 响应OK

func ResPage

func ResPage(c *gin.Context, v interface{}, pr *schema.PaginationResult)

ResPage 响应分页数据

func ResSuccess

func ResSuccess(c *gin.Context, v interface{})

ResSuccess 响应成功

func SetUserID

func SetUserID(c *gin.Context, userID string)

SetUserID 设定用户ID