Documentation
¶
Index ¶
- Constants
- func NewDemoModule() *application.ModuleBuilder
- func NewDevtoolsModule() *application.ModuleBuilder
- func NewMainModule() *application.ModuleBuilder
- func NewTestModule() *application.ModuleBuilder
- type Connector
- type ConnectorRegistration
- type ConnectorRegistry
- type ContentTypeManager
- type Context
- type ContextHolder
- type Controller
- type ControllerRegistration
- type Executor
- func (inst *Executor) DefaultOnClose()
- func (inst *Executor) DefaultOnError(err error)
- func (inst *Executor) DefaultOnOpen(c *gin.Context) error
- func (inst *Executor) DefaultOnPanic(x any)
- func (inst *Executor) DefaultOnSend(err error)
- func (inst *Executor) DefaultOnTask() error
- func (inst *Executor) Execute()
- type ExecutorOnCloseFunc
- type ExecutorOnErrorFunc
- type ExecutorOnOpenFunc
- type ExecutorOnPanicFunc
- type ExecutorOnSendFunc
- type ExecutorOnTaskFunc
- type Group
- type GroupRegistration
- type GroupRegistry
- type Responder
- type ResponderRegistration
- type ResponderRegistry
- type Response
- type Router
- type RouterProxy
- type RouterRegistration
- type RouterRegistry
- type Routing
Constants ¶
const ( GroupREST = "rest" GroupStatic = "static" )
定义常用的分组名称
Variables ¶
This section is empty.
Functions ¶
func NewDemoModule ¶ added in v1.0.9
func NewDemoModule() *application.ModuleBuilder
NewDemoModule 创建模块 [github.com/starter-go/libgin#demo]
func NewDevtoolsModule ¶ added in v1.0.9
func NewDevtoolsModule() *application.ModuleBuilder
NewDevtoolsModule 导出模块 [github.com/starter-go/libgin#devtools]
func NewMainModule ¶ added in v1.0.9
func NewMainModule() *application.ModuleBuilder
NewMainModule 导出模块 github.com/starter-go/libgin
func NewTestModule ¶ added in v1.0.18
func NewTestModule() *application.ModuleBuilder
NewTestModule 创建模块 [github.com/starter-go/libgin#demo]
Types ¶
type ConnectorRegistration ¶
ConnectorRegistration ...
type ConnectorRegistry ¶ added in v1.0.8
type ConnectorRegistry interface {
ListRegistrations() []*ConnectorRegistration
}
ConnectorRegistry ...
type ContentTypeManager ¶
ContentTypeManager 是文档类型管理器
type Context ¶
type Context interface {
GetConnectorByName(name string) (Connector, error)
GetGroupByName(name string) (Group, error)
GetRouterByName(name string) (Router, error)
ListControllersForGroup(groupName string) ([]*ControllerRegistration, error)
}
Context 是 libgin 上下文,它集中管理各种 libgin 资源
type ContextHolder ¶ added in v1.0.4
type ContextHolder struct {
// contains filtered or unexported fields
}
ContextHolder 用来绑定 gin.Context & context.Context
func BindContext ¶ added in v1.0.4
func BindContext(c *gin.Context) *ContextHolder
BindContext 绑定 gin.Context & context.Context
func GetContextHolder ¶ added in v1.0.4
func GetContextHolder(cc context.Context) (*ContextHolder, error)
GetContextHolder 取 ContextHolder
func (*ContextHolder) Context ¶ added in v1.0.7
func (inst *ContextHolder) Context() context.Context
Context ...
func (*ContextHolder) GetValue ¶ added in v1.0.7
func (inst *ContextHolder) GetValue(key any) any
GetValue ...
func (*ContextHolder) GinContext ¶ added in v1.0.4
func (inst *ContextHolder) GinContext() *gin.Context
GinContext 获取绑定的 gin.Context
func (*ContextHolder) SetValue ¶ added in v1.0.7
func (inst *ContextHolder) SetValue(key, value any)
SetValue ...
type Controller ¶
type Controller interface {
Registration() *ControllerRegistration
}
Controller 表示一个 gin 控制器
type ControllerRegistration ¶
type ControllerRegistration struct {
Groups []string // 分组名称, 如果为空表示默认分组
Route func(rp RouterProxy) error // 控制器
}
ControllerRegistration 是控制器注册信息
type Executor ¶ added in v1.0.19
type Executor struct {
Responder Responder
Context *gin.Context
Body1 any
Body2 any
Error error
Status int
// callbacks
OnOpen ExecutorOnOpenFunc
OnSend ExecutorOnSendFunc
OnTask ExecutorOnTaskFunc
OnError ExecutorOnErrorFunc
OnPanic ExecutorOnPanicFunc
OnClose ExecutorOnCloseFunc
}
Executor 是默认的 REST 请求执行对象; 它为 REST API 提供一个便捷的可编程执行过程。
func (*Executor) DefaultOnClose ¶ added in v1.0.19
func (inst *Executor) DefaultOnClose()
func (*Executor) DefaultOnError ¶ added in v1.0.19
func (*Executor) DefaultOnOpen ¶ added in v1.0.19
func (*Executor) DefaultOnPanic ¶ added in v1.0.19
func (*Executor) DefaultOnSend ¶ added in v1.0.19
func (*Executor) DefaultOnTask ¶ added in v1.0.19
type ExecutorOnCloseFunc ¶ added in v1.0.19
type ExecutorOnCloseFunc func()
type ExecutorOnErrorFunc ¶ added in v1.0.19
type ExecutorOnErrorFunc func(err error)
type ExecutorOnOpenFunc ¶ added in v1.0.19
type ExecutorOnPanicFunc ¶ added in v1.0.19
type ExecutorOnPanicFunc func(x any)
type ExecutorOnSendFunc ¶ added in v1.0.19
type ExecutorOnSendFunc func(err error)
type ExecutorOnTaskFunc ¶ added in v1.0.19
type ExecutorOnTaskFunc func() error
type GroupRegistration ¶
GroupRegistration ...
type GroupRegistry ¶ added in v1.0.8
type GroupRegistry interface {
ListRegistrations() []*GroupRegistration
}
GroupRegistry ...
type ResponderRegistration ¶ added in v1.0.2
type ResponderRegistration struct {
Priority int // 优先级,数值越大,越先处理
Name string
Enabled bool
Responder Responder
}
ResponderRegistration 是 Responder 的注册信息
type ResponderRegistry ¶ added in v1.0.2
type ResponderRegistry interface {
ListRegistrations() []*ResponderRegistration
}
ResponderRegistry 是 Responder 的注册接口
type Response ¶
type Response struct {
Context *gin.Context
Status int
Error error
Responder string // 用于选择 Responder,它的值为 ResponderRegistration.Name
Data any
}
Response 表示一个 REST 响应结果
type RouterProxy ¶ added in v1.0.5
type RouterProxy interface {
For(path string) RouterProxy
Route(r *Routing)
Handle(method string, path string, h ...gin.HandlerFunc)
NoMethod(h ...gin.HandlerFunc)
NoRoute(h ...gin.HandlerFunc)
GET(path string, h ...gin.HandlerFunc)
POST(path string, h ...gin.HandlerFunc)
PUT(path string, h ...gin.HandlerFunc)
DELETE(path string, h ...gin.HandlerFunc)
}
RouterProxy ...
type RouterRegistration ¶
RouterRegistration ...
type RouterRegistry ¶ added in v1.0.8
type RouterRegistry interface {
ListRegistrations() []*RouterRegistration
}
RouterRegistry ...
Source Files
¶
Directories
¶
| Path | Synopsis |
|---|---|
|
devtools
|
|
|
gen
|
|
|
modules
|
|
|
src
|
|
|
configen
command
|
|
|
demo/golang
command
|
|
|
devtools
command
|
|
|
main/golang
command
|
|
|
test/golang
command
|
|