Documentation ¶
Index ¶
- func CORS(c *gin.Context)
- func GinHandler(f any) gin.HandlerFunc
- func GinMiddleware(f any) gin.HandlerFunc
- func WithCustomEngine(e *gin.Engine) func(*Module)
- func WithFileName(name string) func(*File)
- func WithMimeType(mimeType string) func(*File)
- func WithPrefix(prefix string) func(*Module)
- type File
- type Filters
- type IFile
- type IMeta
- type IResponse
- type JwtAuthMiddlewareBuilder
- func (j *JwtAuthMiddlewareBuilder) Build() func(*gin.Context) error
- func (j *JwtAuthMiddlewareBuilder) SetHeader(header string) *JwtAuthMiddlewareBuilder
- func (j *JwtAuthMiddlewareBuilder) SetQuery(queryField string) *JwtAuthMiddlewareBuilder
- func (j *JwtAuthMiddlewareBuilder) SetSalt(salt string) *JwtAuthMiddlewareBuilder
- func (j *JwtAuthMiddlewareBuilder) SetUserIdentifier(f func(claims jwt2.MapClaims) error) *JwtAuthMiddlewareBuilder
- type Meta
- type Module
- func (m *Module) Any(route string, handler any, middlewares ...any) Router
- func (m *Module) DELETE(route string, handler any, middlewares ...any) Router
- func (m *Module) GET(route string, handler any, middlewares ...any) Router
- func (m *Module) Group(prefix string, middlewares ...any) Router
- func (m *Module) HEAD(route string, handler any, middlewares ...any) Router
- func (m *Module) Init() (err error)
- func (m *Module) OPTIONS(route string, handler any, middlewares ...any) Router
- func (m *Module) PATCH(route string, handler any, middlewares ...any) Router
- func (m *Module) POST(route string, handler any, middlewares ...any) Router
- func (m *Module) PUT(route string, handler any, middlewares ...any) Router
- func (m *Module) Start()
- func (m *Module) Stop()
- type NewResponseFunc
- type Page
- type RestfulResponse
- func (r *RestfulResponse) Do(ctx *gin.Context)
- func (r *RestfulResponse) SetData(data any) IResponse[*gin.Context]
- func (r *RestfulResponse) SetError(err error) IResponse[*gin.Context]
- func (r *RestfulResponse) SetFile(file IFile) IResponse[*gin.Context]
- func (r *RestfulResponse) SetMeta(meta IMeta) IResponse[*gin.Context]
- type Router
- type Sorts
Constants ¶
This section is empty.
Variables ¶
This section is empty.
Functions ¶
func GinHandler ¶
func GinHandler(f any) gin.HandlerFunc
func GinMiddleware ¶
func GinMiddleware(f any) gin.HandlerFunc
func WithCustomEngine ¶
func WithFileName ¶
func WithMimeType ¶
func WithPrefix ¶
Types ¶
type Filters ¶
type Filters struct {
// contains filtered or unexported fields
}
func NewFiltersFromCtx ¶
type IResponse ¶
type IResponse[CTX any] interface { SetData(any) IResponse[CTX] SetMeta(IMeta) IResponse[CTX] SetError(error) IResponse[CTX] SetFile(IFile) IResponse[CTX] Do(CTX) }
func NewRestfulResponse ¶
type JwtAuthMiddlewareBuilder ¶
type JwtAuthMiddlewareBuilder struct {
// contains filtered or unexported fields
}
func NewJwtAuthMiddlewareBuilder ¶
func NewJwtAuthMiddlewareBuilder() *JwtAuthMiddlewareBuilder
func (*JwtAuthMiddlewareBuilder) Build ¶
func (j *JwtAuthMiddlewareBuilder) Build() func(*gin.Context) error
func (*JwtAuthMiddlewareBuilder) SetHeader ¶
func (j *JwtAuthMiddlewareBuilder) SetHeader(header string) *JwtAuthMiddlewareBuilder
func (*JwtAuthMiddlewareBuilder) SetQuery ¶
func (j *JwtAuthMiddlewareBuilder) SetQuery(queryField string) *JwtAuthMiddlewareBuilder
func (*JwtAuthMiddlewareBuilder) SetSalt ¶
func (j *JwtAuthMiddlewareBuilder) SetSalt(salt string) *JwtAuthMiddlewareBuilder
func (*JwtAuthMiddlewareBuilder) SetUserIdentifier ¶
func (j *JwtAuthMiddlewareBuilder) SetUserIdentifier(f func(claims jwt2.MapClaims) error) *JwtAuthMiddlewareBuilder
type NewResponseFunc ¶
type RestfulResponse ¶
type RestfulResponse struct { Data any `json:"data"` Message string `json:"message"` Meta map[string]any `json:"meta,omitempty"` // contains filtered or unexported fields }
func (*RestfulResponse) Do ¶
func (r *RestfulResponse) Do(ctx *gin.Context)
func (*RestfulResponse) SetData ¶
func (r *RestfulResponse) SetData(data any) IResponse[*gin.Context]
func (*RestfulResponse) SetError ¶
func (r *RestfulResponse) SetError(err error) IResponse[*gin.Context]
type Router ¶
type Router interface { Any(route string, handler any, middlewares ...any) Router GET(route string, handler any, middlewares ...any) Router POST(route string, handler any, middlewares ...any) Router DELETE(route string, handler any, middlewares ...any) Router PATCH(route string, handler any, middlewares ...any) Router PUT(route string, handler any, middlewares ...any) Router OPTIONS(route string, handler any, middlewares ...any) Router HEAD(route string, handler any, middlewares ...any) Router Group(prefix string, middlewares ...any) Router }
Click to show internal directories.
Click to hide internal directories.