ginx

package

v1.6.2 Latest Latest Go to latest Published: Aug 18, 2025 License: MIT Imports: 6 Imported by: 0

Details

Valid go.mod file
Redistributable license
Tagged version
Stable version
Learn more about best practices

Repository

github.com/TencentBlueKing/blueapps-go

Links

Open Source Insights

Documentation ¶

Overview ¶

Package ginx 提供一些 Gin 框架相关的工具

Index ¶

func GetError(c *gin.Context) (err any, ok bool)
func GetLang(c *gin.Context) i18n.Lang
func GetLimit(c *gin.Context) int
func GetOffset(c *gin.Context) int
func GetPage(c *gin.Context) int
func GetRequestID(c *gin.Context) string
func GetTracer(c *gin.Context) trace.Tracer
func GetUserID(c *gin.Context) string
func SetErrResp(c *gin.Context, statusCode int, message string)
func SetError(c *gin.Context, err error)
func SetLang(c *gin.Context, lang i18n.Lang)
func SetRequestID(c *gin.Context, requestID string)
func SetResp(c *gin.Context, statusCode int, data any)
func SetTracer(c *gin.Context, tracer trace.Tracer)
func SetUserID(c *gin.Context, userID string)
type PaginatedResp
- func NewPaginatedRespData(count int64, results any) PaginatedResp
type Response

Constants ¶

This section is empty.

Variables ¶

This section is empty.

Functions ¶

func GetError ¶

func GetError(c *gin.Context) (err any, ok bool)

GetError ...

func GetLang ¶

func GetLang(c *gin.Context) i18n.Lang

GetLang ...

func GetLimit ¶

func GetLimit(c *gin.Context) int

GetLimit 获取分页参数 Limit

func GetOffset ¶

func GetOffset(c *gin.Context) int

GetOffset 获取分页参数 Offset

func GetPage ¶

func GetPage(c *gin.Context) int

GetPage 获取分页参数 Page

func GetRequestID ¶

func GetRequestID(c *gin.Context) string

GetRequestID ...

func GetTracer ¶

func GetTracer(c *gin.Context) trace.Tracer

GetTracer 获取 tracer（the creator of Spans）

func GetUserID ¶

func GetUserID(c *gin.Context) string

GetUserID ...

func SetErrResp ¶

func SetErrResp(c *gin.Context, statusCode int, message string)

SetErrResp 为指定的 gin.Context 设置错误响应数据

func SetError ¶

func SetError(c *gin.Context, err error)

SetError ...

func SetLang ¶

func SetLang(c *gin.Context, lang i18n.Lang)

SetLang ...

func SetRequestID ¶

func SetRequestID(c *gin.Context, requestID string)

SetRequestID ...

func SetResp ¶

func SetResp(c *gin.Context, statusCode int, data any)

SetResp 为指定的 gin.Context 设置成功响应数据（建议 200 <= statusCode < 300）

func SetTracer ¶

func SetTracer(c *gin.Context, tracer trace.Tracer)

SetTracer ...

func SetUserID ¶

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

SetUserID ...

Types ¶

type PaginatedResp ¶

type PaginatedResp struct {
	Count   int64 `json:"count"`
	Results any   `json:"results"`
}

PaginatedResp 分页响应数据体

func NewPaginatedRespData ¶

func NewPaginatedRespData(count int64, results any) PaginatedResp

NewPaginatedRespData 创建分页响应数据体注意：results 类型应该是 Slice / Array

type Response ¶

type Response struct {
	Message   string `json:"message"`
	Data      any    `json:"data"`
	RequestID string `json:"requestID"`
}

Response 通用响应体

Source Files ¶

View all Source files

?	: This menu
/	: Search site
f or F	: Jump to
y or Y	: Canonical URL