ginx

package

v0.0.5 Latest Latest Go to latest Published: Dec 7, 2024 License: Apache-2.0 Imports: 7 Imported by: 0

Details

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

Repository

github.com/StarJoice/tools

Links

Open Source Insights

Documentation ¶

Index ¶

func WithRequest[Req any](fn func(ctx *Context, req Req) (Result, error)) gin.HandlerFunc
func WithResult(fn func(ctx *Context) (Result, error)) gin.HandlerFunc
func WithSession(fn func(ctx *Context, sess session.Session) (Result, error)) gin.HandlerFunc
func WithSessionAndRequest[Req any](fn func(ctx *Context, req Req, sess session.Session) (Result, error)) gin.HandlerFunc
type Context
type Handler
type Result

Constants ¶

This section is empty.

Variables ¶

This section is empty.

Functions ¶

func WithRequest ¶

func WithRequest[Req any](fn func(ctx *Context, req Req) (Result, error)) gin.HandlerFunc

WithRequest 将一个接受请求参数的业务逻辑函数封装成 Gin 的 Handler。它会自动绑定请求参数并处理业务逻辑，同时处理错误情况。

func WithResult ¶

func WithResult(fn func(ctx *Context) (Result, error)) gin.HandlerFunc

WithResult 将一个接受上下文的业务逻辑函数封装成 Gin 的 Handler。它自动处理业务逻辑中的错误情况，并返回对应的 HTTP 状态码和响应数据。

func WithSession ¶ added in v0.0.5

func WithSession(fn func(ctx *Context, sess session.Session) (Result, error)) gin.HandlerFunc

WithSession 的意思是，传入的业务逻辑方法仅可以接受 Session 参数

func WithSessionAndRequest ¶ added in v0.0.5

func WithSessionAndRequest[Req any](fn func(ctx *Context, req Req, sess session.Session) (Result, error)) gin.HandlerFunc

WithSessionAndRequest 的意思是，传入的业务逻辑方法可以接受 req 和 sess 两个参数

Types ¶

type Context ¶

type Context = gctx.Context

Context 为 `gctx.Context` 类型的别名，这样可以在其他地方使用 `Context` 来代替 `gctx.Context`，方便管理自定义的请求上下文。

type Handler ¶

type Handler interface {
	PrivateRoutes(server *gin.Engine)
	PublicRoutes(server *gin.Engine)
}

Handler 定义了处理路由的接口，包含两个方法： - PrivateRoutes: 用于注册私有路由 - PublicRoutes: 用于注册公共路由实现该接口的结构体必须提供这两个方法。

type Result ¶

type Result struct {
	Code int    `json:"code"`
	Msg  string `json:"msg"`
	Data any    `json:"data"`
}

Result 是一个通用的 API 响应结构体，用于标准化响应格式。 - Code: 响应的状态码，通常用于表示请求是否成功。(一般为自定义的系统内的错误码) - Msg: 响应的消息描述，通常用于提示成功或错误信息。 - Data: 响应的数据部分，类型为 `any`，可以是任何类型，表示返回的具体数据。

Source Files ¶

View all Source files

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