mgboot

package
v1.0.0 Latest Latest
Warning

This package is not in the latest version of its module.

 Go to latest Published: Dec 29, 2021 License: MIT Imports: 36 Imported by: 0

Documentation

Index

Constants

This section is empty.

Variables

This section is empty.

Functions

func AddCorsSupport 

func AddCorsSupport(ctx *gin.Context)

func AddPoweredBy 

func AddPoweredBy(ctx *gin.Context)

func BuildJsonWebToken 

func BuildJsonWebToken(arg0 interface{}, isRefreshToken bool, claims ...map[string]interface{}) (token string, err error)

@param *JwtSettings|string arg0

func ExecuteTimeLogEnabled 

func ExecuteTimeLogEnabled() bool

func ExecuteTimeLogLogger 

func ExecuteTimeLogLogger(logger ...logx.Logger) logx.Logger

func GetJwtPrivateKeyPemFile 

func GetJwtPrivateKeyPemFile() string

func GetJwtPublicKeyPemFile 

func GetJwtPublicKeyPemFile() string

func JwtClaimBool 

func JwtClaimBool(arg0 interface{}, name string, defaultValue ...bool) bool

@param *jwt.Token|string arg0

func JwtClaimFloat32 

func JwtClaimFloat32(arg0 interface{}, name string, defaultValue ...float32) float32

@param *jwt.Token|string arg0

func JwtClaimFloat64 

func JwtClaimFloat64(arg0 interface{}, name string, defaultValue ...float64) float64

@param *jwt.Token|string arg0

func JwtClaimInt 

func JwtClaimInt(arg0 interface{}, name string, defaultValue ...int) int

@param *jwt.Token|string arg0

func JwtClaimInt64 

func JwtClaimInt64(arg0 interface{}, name string, defaultValue ...int64) int64

@param *jwt.Token|string arg0

func JwtClaimIntSlice 

func JwtClaimIntSlice(arg0 interface{}, name string) []int

@param *jwt.Token|string arg0

func JwtClaimString 

func JwtClaimString(arg0 interface{}, name string, defaultValue ...string) string

@param *jwt.Token|string arg0

func JwtClaimStringSlice 

func JwtClaimStringSlice(arg0 interface{}, name string) []string

@param *jwt.Token|string arg0

func LogExecuteTime 

func LogExecuteTime(ctx *gin.Context)

func LogRequestBody 

func LogRequestBody(flag ...bool) bool

func MidFinalStep 

func MidFinalStep() gin.HandlerFunc

func MidJwtAuth 

func MidJwtAuth(settingsKey string) gin.HandlerFunc

func MidOptionsReq 

func MidOptionsReq() gin.HandlerFunc

func MidRateLimit 

func MidRateLimit(handlerName string, settings interface{}) gin.HandlerFunc

func MidRecover 

func MidRecover() gin.HandlerFunc

func MidRequestBody 

func MidRequestBody() gin.HandlerFunc

func MidRequestLog 

func MidRequestLog() gin.HandlerFunc

func MidValidate 

func MidValidate(arg0 interface{}) gin.HandlerFunc

func NeedCorsSupport 

func NeedCorsSupport(ctx *gin.Context) bool

func NewFilePart 

func NewFilePart(formFieldName, clientFileName, fpath string) filePart

noinspection GoExportedFuncWithUnexportedType

func NewFilePartFromBuffer 

func NewFilePartFromBuffer(formFieldName, clientFileName string, buf []byte) filePart

noinspection GoExportedFuncWithUnexportedType

func NewHttpClient 

func NewHttpClient(requestUrl string) httpClient

noinspection GoExportedFuncWithUnexportedType

func NewJwtAuthErrorHandler 

func NewJwtAuthErrorHandler() *jwtAuthErrorHandler

func NewNoopLogger 

func NewNoopLogger() *noopLogger

func NewNormalPart 

func NewNormalPart(data map[string]string) normalPart

noinspection GoExportedFuncWithUnexportedType

func NewRateLimitErrorHandler 

func NewRateLimitErrorHandler() *rateLimitErrorHandler

func NewValidateErrorHandler 

func NewValidateErrorHandler() *validateErrorHandler

func ParseJsonWebToken 

func ParseJsonWebToken(token string, pubpem ...string) (*jwt.Token, error)

func RatelimiterCacheDir 

func RatelimiterCacheDir() string

func RatelimiterLuaFile 

func RatelimiterLuaFile() string

func ReplaceBuiltinErrorHandler 

func ReplaceBuiltinErrorHandler(errName string, handler ErrorHandler)

func RequestLogEnabled 

func RequestLogEnabled() bool

func RequestLogLogger 

func RequestLogLogger(logger ...logx.Logger) logx.Logger

func RuntimeLogger 

func RuntimeLogger(logger ...logx.Logger) logx.Logger

func VerifyJsonWebToken 

func VerifyJsonWebToken(arg0 interface{}, settings *JwtSettings) int

@param *jwt.Token|string arg0

func WithBuiltinErrorHandlers 

func WithBuiltinErrorHandlers()

func WithCorsSettings 

func WithCorsSettings(settings ...map[string]interface{})

func WithErrorHandler 

func WithErrorHandler(handler ErrorHandler)

func WithErrorHandlers 

func WithErrorHandlers(handlers []ErrorHandler)

func WithJwtPrivateKeyPemFile 

func WithJwtPrivateKeyPemFile(fpath string)

func WithJwtPublicKeyPemFile 

func WithJwtPublicKeyPemFile(fpath string)

func WithJwtSettings 

func WithJwtSettings(key string, settings ...map[string]interface{})

func WithRatelimiterCacheDir 

func WithRatelimiterCacheDir(dir string)

func WithRatelimiterLuaFile 

func WithRatelimiterLuaFile(fpath string)

Types

type AttachmentResponse 

type AttachmentResponse struct {
	// contains filtered or unexported fields
}

func NewAttachmentResponseFromBuffer 

func NewAttachmentResponseFromBuffer(buf []byte, attachmentFileName string, mimeType ...string) AttachmentResponse

func NewAttachmentResponseFromFile 

func NewAttachmentResponseFromFile(fpath, attachmentFileName string, mimeType ...string) AttachmentResponse

func (AttachmentResponse) AddSpecifyHeaders 

func (p AttachmentResponse) AddSpecifyHeaders(ctx *gin.Context)

func (AttachmentResponse) Buffer 

func (p AttachmentResponse) Buffer() []byte

func (AttachmentResponse) GetContentType 

func (p AttachmentResponse) GetContentType() string

func (AttachmentResponse) GetContents 

func (p AttachmentResponse) GetContents() (int, string)

type CorsSettings 

type CorsSettings struct {
	// contains filtered or unexported fields
}

func GetCorsSettings 

func GetCorsSettings() *CorsSettings

func NewCorsSettings 

func NewCorsSettings(settings map[string]interface{}) *CorsSettings

func (*CorsSettings) AllowCredentials 

func (st *CorsSettings) AllowCredentials() bool

func (*CorsSettings) AllowedHeaders 

func (st *CorsSettings) AllowedHeaders() []string

func (*CorsSettings) AllowedMethods 

func (st *CorsSettings) AllowedMethods() []string

func (*CorsSettings) AllowedOrigins 

func (st *CorsSettings) AllowedOrigins() []string

func (*CorsSettings) ExposedHeaders 

func (st *CorsSettings) ExposedHeaders() []string

func (*CorsSettings) MaxAge 

func (st *CorsSettings) MaxAge() time.Duration

type ErrorHandler 

type ErrorHandler interface {
	GetErrorName() string
	MatchError(err error) bool
	HandleError(err error) ResponsePayload
}

func ErrorHandlers 

func ErrorHandlers() []ErrorHandler

type HtmlResponse 

type HtmlResponse struct {
	// contains filtered or unexported fields
}

func NewHtmlResponse 

func NewHtmlResponse(contents string) HtmlResponse

func (HtmlResponse) GetContentType 

func (p HtmlResponse) GetContentType() string

func (HtmlResponse) GetContents 

func (p HtmlResponse) GetContents() (int, string)

type HttpErrorResponse 

type HttpErrorResponse struct {
	// contains filtered or unexported fields
}

func NewHttpErrorResponse 

func NewHttpErrorResponse(statusCode int) HttpErrorResponse

func (HttpErrorResponse) GetContentType 

func (p HttpErrorResponse) GetContentType() string

func (HttpErrorResponse) GetContents 

func (p HttpErrorResponse) GetContents() (int, string)

type ImageResponse 

type ImageResponse struct {
	// contains filtered or unexported fields
}

func NewImageResponseFromBuffer 

func NewImageResponseFromBuffer(buf []byte, mimeType ...string) ImageResponse

func NewImageResponseFromFile 

func NewImageResponseFromFile(fpath string, mimeType ...string) ImageResponse

func (ImageResponse) Buffer 

func (p ImageResponse) Buffer() []byte

func (ImageResponse) GetContentType 

func (p ImageResponse) GetContentType() string

func (ImageResponse) GetContents 

func (p ImageResponse) GetContents() (int, string)

type JsonResponse 

type JsonResponse struct {
	// contains filtered or unexported fields
}

func NewJsonResponse 

func NewJsonResponse(payload interface{}) JsonResponse

func (JsonResponse) GetContentType 

func (p JsonResponse) GetContentType() string

func (JsonResponse) GetContents 

func (p JsonResponse) GetContents() (statusCode int, contents string)

type JwtAuthError 

type JwtAuthError struct {
	// contains filtered or unexported fields
}

func NewJwtAuthError 

func NewJwtAuthError(errno int) JwtAuthError

func (JwtAuthError) Errno 

func (ex JwtAuthError) Errno() int

func (JwtAuthError) Error 

func (ex JwtAuthError) Error() string

type JwtSettings 

type JwtSettings struct {
	// contains filtered or unexported fields
}

func GetJwtSettings 

func GetJwtSettings(key string) *JwtSettings

func NewJwtSettings 

func NewJwtSettings(settings map[string]interface{}) *JwtSettings

func (*JwtSettings) Issuer 

func (st *JwtSettings) Issuer() string

func (*JwtSettings) PrivateKeyPemFile 

func (st *JwtSettings) PrivateKeyPemFile() string

func (*JwtSettings) PublicKeyPemFile 

func (st *JwtSettings) PublicKeyPemFile() string

func (*JwtSettings) RefreshTokenTtl 

func (st *JwtSettings) RefreshTokenTtl() time.Duration

func (*JwtSettings) Ttl 

func (st *JwtSettings) Ttl() time.Duration

type RateLimitError 

type RateLimitError struct {
	// contains filtered or unexported fields
}

func NewRateLimitError 

func NewRateLimitError(data map[string]interface{}) RateLimitError

func (RateLimitError) AddSpecifyHeaders 

func (ex RateLimitError) AddSpecifyHeaders(ctx *gin.Context)

func (RateLimitError) Error 

func (ex RateLimitError) Error() string

func (RateLimitError) Remaining 

func (ex RateLimitError) Remaining() int

func (RateLimitError) RetryAfter 

func (ex RateLimitError) RetryAfter() string

func (RateLimitError) Total 

func (ex RateLimitError) Total() int

type Request 

type Request struct {
	// contains filtered or unexported fields
}

func NewRequest 

func NewRequest(ctx *gin.Context) *Request

func (*Request) DtoBind 

func (r *Request) DtoBind(dto interface{}) error

func (*Request) GetClientIp 

func (r *Request) GetClientIp() string

func (*Request) GetFormData 

func (r *Request) GetFormData() map[string]string

func (*Request) GetHeader 

func (r *Request) GetHeader(name string) string

func (*Request) GetHeaders 

func (r *Request) GetHeaders() map[string]string

func (*Request) GetJwt 

func (r *Request) GetJwt() *jwt.Token

func (*Request) GetMap 

func (r *Request) GetMap(rules ...interface{}) map[string]interface{}

@param string[]|string rules

func (*Request) GetMethod 

func (r *Request) GetMethod() string

func (*Request) GetQueryParams 

func (r *Request) GetQueryParams() map[string]string

func (*Request) GetQueryString 

func (r *Request) GetQueryString(urlencode ...bool) string

func (*Request) GetRawBody 

func (r *Request) GetRawBody() []byte

func (*Request) GetRequestUrl 

func (r *Request) GetRequestUrl(withQueryString ...bool) string

func (*Request) GetUploadedFile 

func (r *Request) GetUploadedFile(formFieldName string) *multipart.FileHeader

func (*Request) JwtClaimBool 

func (r *Request) JwtClaimBool(name string, defaultValue ...interface{}) bool

func (*Request) JwtClaimFloat32 

func (r *Request) JwtClaimFloat32(name string, defaultValue ...interface{}) float32

func (*Request) JwtClaimFloat64 

func (r *Request) JwtClaimFloat64(name string, defaultValue ...interface{}) float64

func (*Request) JwtClaimInt 

func (r *Request) JwtClaimInt(name string, defaultValue ...interface{}) int

func (*Request) JwtClaimInt64 

func (r *Request) JwtClaimInt64(name string, defaultValue ...interface{}) int64

func (*Request) JwtClaimIntSlice 

func (r *Request) JwtClaimIntSlice(name string) []int

func (*Request) JwtClaimString 

func (r *Request) JwtClaimString(name string, defaultValue ...interface{}) string

func (*Request) JwtClaimStringSlice 

func (r *Request) JwtClaimStringSlice(name string) []string

func (*Request) ParamBool 

func (r *Request) ParamBool(name string, defaultValue ...interface{}) bool

func (*Request) ParamFloat32 

func (r *Request) ParamFloat32(name string, defaultValue ...interface{}) float32

func (*Request) ParamFloat64 

func (r *Request) ParamFloat64(name string, defaultValue ...interface{}) float64

func (*Request) ParamInt 

func (r *Request) ParamInt(name string, defaultValue ...interface{}) int

func (*Request) ParamInt64 

func (r *Request) ParamInt64(name string, defaultValue ...interface{}) int64

func (*Request) ParamString 

func (r *Request) ParamString(name string, defaultValue ...interface{}) string

func (*Request) ParamStringWithSecurityMode 

func (r *Request) ParamStringWithSecurityMode(name string, mode int, defaultValue ...interface{}) string

func (*Request) PathvariableBool 

func (r *Request) PathvariableBool(name string, defaultValue ...interface{}) bool

func (*Request) PathvariableFloat32 

func (r *Request) PathvariableFloat32(name string, defaultValue ...interface{}) float32

func (*Request) PathvariableFloat64 

func (r *Request) PathvariableFloat64(name string, defaultValue ...interface{}) float64

func (*Request) PathvariableInt 

func (r *Request) PathvariableInt(name string, defaultValue ...interface{}) int

func (*Request) PathvariableInt64 

func (r *Request) PathvariableInt64(name string, defaultValue ...interface{}) int64

func (*Request) PathvariableString 

func (r *Request) PathvariableString(name string, defaultValue ...interface{}) string

type ResponsePayload 

type ResponsePayload interface {
	GetContentType() string
	GetContents() (int, string)
}

type ValidateError 

type ValidateError struct {
	// contains filtered or unexported fields
}

func NewValidateError 

func NewValidateError(args ...interface{}) ValidateError

func (ValidateError) Error 

func (ex ValidateError) Error() string

func (ValidateError) Failfast 

func (ex ValidateError) Failfast() bool

func (ValidateError) ValidateErrors 

func (ex ValidateError) ValidateErrors() map[string]string

type XmlResponse 

type XmlResponse struct {
	// contains filtered or unexported fields
}

func NewXmlResponse 

func NewXmlResponse(contents string) XmlResponse

func (XmlResponse) GetContentType 

func (p XmlResponse) GetContentType() string

func (XmlResponse) GetContents 

func (p XmlResponse) GetContents() (int, string)

Source Files

View all Source files

Jump to

Keyboard shortcuts

? : This menu
/ : Search site
f or F : Jump to
y or Y : Canonical URL
go.dev uses cookies from Google to deliver and enhance the quality of its services and to analyze traffic. Learn more.