ginstarter

Jul 4, 2025

Changes in this version

type Request

+ func (r *Request) MustBindBodyAuto(object any)

+ func (r *Request) Panic(statusCode int, err error)

May 22, 2025

Changes in this version

type RouterInfo

+ PostInterceptors []PostInterceptor

+ PreInterceptors []PreInterceptor

Apr 8, 2025

Changes in this version

type GinConfig

+ UseReusePortModel bool

Jan 21, 2025

Changes in this version

type RestRespStruct

+ func (r *RestRespStruct) IsSuccess() bool

+ func (r *RestRespStruct) IsSuccessWithData() bool

Jan 13, 2025

Changes in this version

+ const GinCtxKeyResponse

type GinConfig

+ GlobalPostInterceptors []PostInterceptor

+ GlobalPreInterceptors []PreInterceptor

+ type PostInterceptor func(request *Request, response Response) bool

+ type PreInterceptor func(request *Request) (Response, bool)

+ func BasicAuthInterceptor(account *BasicAuthAccount, match ...func(request *Request) bool) PreInterceptor

+ func MediaTypeInterceptor(contentType []string, match ...func(request *Request) bool) PreInterceptor

type ResponseData

+ func (r *ResponseData) ToDebugString() string

type RouterInfo

+ Interceptors []PreInterceptor

Dec 10, 2024

Changes in this version

+ type GinConfig struct

+ BadHttpCodeResolver BadHttpCodeResolver

+ DebugModule bool

+ DisableBadHttpCodeResolver bool

+ DisableDefaultIgnoreHttpCode bool

+ DisableForwardedByClientIP bool

+ DisableMethodNotAllowedError bool

+ EnableGoroutineTraceIdResponse bool

+ GlobalMiddlewares []Middleware

+ HidePanicErrorDetails bool

+ IgnoreHttpCode []int

+ InitFunc func(instance *gin.Engine)

+ ListenAddress string

+ MaxMultipartMemory int64

+ PanicResolver PanicResolver

+ ResponseDataStructDecoder ResponseDataStructDecoder

+ Routers []Router

type GinStarter

+ Config GinConfig

+ LazyConfig func() GinConfig

Nov 6, 2024

Changes in this version

type RestRespStruct

+ func NewRestBadParameters(statusMessage ...string) *RestRespStruct

Oct 12, 2024

Changes in this version

type Request

+ func (r *Request) GetFormArray(name string) ([]string, bool)

+ func (r *Request) GetFormMap(name string) (map[string]string, bool)

+ func (r *Request) GetFormValue(name string) (string, bool)

+ func (r *Request) MustGetFormArray(name string) []string

+ func (r *Request) MustGetFormMap(name string) map[string]string

+ func (r *Request) MustGetFormValue(name string) string

Sep 25, 2024

Changes in this version

type Request

+ func (r *Request) MustGetRawBodyString() string

type Response

+ func RespRestRaw(dataRest *RestRespStruct) Response

type RestRespStruct

+ func NewRestBadBadParameters(statusMessage ...string) *RestRespStruct

+ func NewRestBizError(bizErrorCode BizErrorCode, bizErrorMessage BizErrorMessage) *RestRespStruct

+ func NewRestException(statusMessage ...string) *RestRespStruct

+ func NewRestStatusError(statusCode StatusCode, statusMessage ...StatusMessage) *RestRespStruct

+ func NewRestSuccess(data ...interface{}) *RestRespStruct

+ func NewRestUnauthorized(statusMessage ...string) *RestRespStruct

Sep 20, 2024

Changes in this version

type Request

+ func (r *Request) GetValue(key string) (interface{}, bool)

+ func (r *Request) SetValue(key string, value interface{})

type Response

+ func RespRestBadParameters(statusMessage ...string) Response

+ func RespRestUnAuthorized(statusMessage ...string) Response

Jul 18, 2024

Changes in this version

+ type BadHttpCodeResolver func(httpStatusCode int, errMsg string) Response

type GinStarter

+ BadHttpCodeResolver BadHttpCodeResolver

+ DisableBadHttpCodeResolver bool

+ DisableDefaultIgnoreHttpCode bool

+ HidePanicErrorDetails bool

+ IgnoreHttpCode []int

+ PanicResolver PanicResolver

type Middleware

+ func MediaTypeMiddleware(contentType []string, match ...func(request *Request) bool) Middleware

+ type PanicResolver func(err error) string

type ResponseData

+ func NewResponseDataWithStatusCode(contentType string, body []byte, statusCode int) *ResponseData

type RouterWrapper

+ func (r *RouterWrapper) DELETE1(path string, contentType []string, handler ...HandlerWrapper)

+ func (r *RouterWrapper) MATCH1(method []string, path string, contentType []string, handler ...HandlerWrapper)

+ func (r *RouterWrapper) PATCH1(path string, contentType []string, handler ...HandlerWrapper)

+ func (r *RouterWrapper) POST1(path string, contentType []string, handler ...HandlerWrapper)

+ func (r *RouterWrapper) PUT1(path string, contentType []string, handler ...HandlerWrapper)

+ func (r *RouterWrapper) TRACE1(path string, contentType []string, handler ...HandlerWrapper)

Jul 10, 2024

Changes in this version

type GinStarter

+ GlobalMiddlewares []Middleware

+ type Middleware func(request *Request) (Response, bool)

+ func BasicAuthMiddleware(account *BasicAuthAccount) Middleware

type Request

+ func (r *Request) RequestFullPath() string

+ func (r *Request) RequestPath() string

+ func (r *Request) RouterFullPath() string

type RouterInfo

+ Middlewares []Middleware

Jul 5, 2024

Changes in this version

type Request

+ func (r *Request) Host() string

+ func (r *Request) Proto() string

type ResponseData

+ func NewEmptyResponseData() *ResponseData

Jun 26, 2024

Changes in this version

+ func RawGinEngine() *gin.Engine

type GinStarter

+ GinSetting *parent.Setting

Jun 26, 2024

Changes in this version

+ const StatusCodeAuthorityUnavailable

+ const StatusCodeBadRequestParameters

+ const StatusCodeExceededLimit

+ const StatusCodeException

+ const StatusCodeForbidden

+ const StatusCodeMediaTypeNotAllowed

+ const StatusCodeMethodNotAllowed

+ const StatusCodeNotFound

+ const StatusCodeServiceUnavailable

+ const StatusCodeSuccess

+ const StatusCodeTimeout

+ const StatusCodeUnauthorized

+ const StatusCodeUploadLimitExceeded

+ func NewCommonResp() *commonResp

+ func NewRespRest() *restResp

+ type BasicAuthAccount struct

+ Password string

+ Username string

+ type BizErrorCode int

+ type BizErrorMessage string

+ type GinStarter struct

+ DebugModule bool

+ DisableForwardedByClientIP bool

+ DisableHttpStatusCodeHandler bool

+ DisableMethodNotAllowedError bool

+ DisabledDefaultIgnoreHttpStatusCode bool

+ GinModuleConfig *parent.Setting

+ HttpStatusCodeCodeHandlerResponse HttpStatusCodeCodeHandlerResponse

+ IgnoreHttpStatusCode []int

+ InitFunc func(instance *gin.Engine)

+ ListenAddress string

+ MaxMultipartMemory int64

+ RecoverHandlerResponse RecoverHandlerResponse

+ ResponseDataStructDecoder ResponseDataStructDecoder

+ Routers []Router

+ func (g *GinStarter) Setting() *parent.Setting

+ func (g *GinStarter) Start() (interface{}, error)

+ func (g *GinStarter) Stop(maxWaitTime time.Duration) (gracefully, stopped bool, err error)

+ type HandlerWrapper func(request *Request) (Response, error)

+ type HttpStatusCodeCodeHandlerResponse func(ctx *gin.Context, httpStatusCode int) Response

+ type RecoverHandlerResponse func(ctx *gin.Context, err any) Response

+ type Request struct

+ func (r *Request) BindBodyForm(object any) error

+ func (r *Request) BindBodyJson(object any) error

+ func (r *Request) BindPathParams(object any) error

+ func (r *Request) BindQueryParams(object any) error

+ func (r *Request) FullPath() string

+ func (r *Request) GetCookie(name string) (string, error)

+ func (r *Request) GetFormFile(name string) (*multipart.FileHeader, error)

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

+ func (r *Request) GetPathParam(name string) string

+ func (r *Request) GetPathParams(names ...string) map[string]string

+ func (r *Request) GetQueryParam(name string) (string, bool)

+ func (r *Request) GetQueryParamArray(name string) ([]string, bool)

+ func (r *Request) GetQueryParamMap(name string) (map[string]string, bool)

+ func (r *Request) GetQueryParams(names ...string) map[string]string

+ func (r *Request) GetRawBodyData() ([]byte, error)

+ func (r *Request) HttpMethod() string

+ func (r *Request) MustBindBodyForm(object any)

+ func (r *Request) MustBindBodyJson(object any)

+ func (r *Request) MustBindPathParams(object any)

+ func (r *Request) MustBindQueryParams(object any)

+ func (r *Request) MustGetCookie(name string) string

+ func (r *Request) MustGetFormFile(name string) *multipart.FileHeader

+ func (r *Request) MustGetQueryParam(name string) string

+ func (r *Request) MustGetQueryParamArray(name string) []string

+ func (r *Request) MustGetQueryParamMap(name string) map[string]string

+ func (r *Request) MustGetQueryParams(names ...string) map[string]string

+ func (r *Request) MustGetRawBodyData() []byte

+ func (r *Request) MustSaveUploadedFile(name string, dirPath string, filename ...string)

+ func (r *Request) RawGinContext() *gin.Context

+ func (r *Request) RequestIP() string

+ func (r *Request) SaveUploadedFile(name string, dirPath string, filename ...string) error

+ type Response interface

+ Data func() *ResponseData

+ func RespAbortWithHttpStatusCode(statusCode int) Response

+ func RespHttpStatusCode(statusCode int) Response

+ func RespJson(data any, httpStatusCode ...int) Response

+ func RespRedirect(url string, httpStatusCode ...int) Response

+ func RespRestBizError(bizErrorCode *BizErrorCode, bizErrorMessage *BizErrorMessage) Response

+ func RespRestException() Response

+ func RespRestStatusError(statusCode StatusCode, statusMessage ...StatusMessage) Response

+ func RespRestSuccess(data ...any) Response

+ func RespTextPlain(data string, httpStatusCode ...int) Response

+ func RespToml(data any, httpStatusCode ...int) Response

+ func RespXml(data any, httpStatusCode ...int) Response

+ func RespYaml(data any, httpStatusCode ...int) Response

+ type ResponseCookie struct

+ func NewCookie(name, value string, maxAge int, path, domain string, secure, httpOnly bool) *ResponseCookie

+ type ResponseData struct

+ func NewResponseData() *ResponseData

+ func (r *ResponseData) AddCookie(cookie *ResponseCookie) *ResponseData

+ func (r *ResponseData) AddCookies(cookies []*ResponseCookie) *ResponseData

+ func (r *ResponseData) AddHeader(header *ResponseHeader) *ResponseData

+ func (r *ResponseData) AddHeaders(headers []*ResponseHeader) *ResponseData

+ func (r *ResponseData) SetContentType(contentType string) *ResponseData

+ func (r *ResponseData) SetData(data []byte) *ResponseData

+ func (r *ResponseData) SetStatusCode(statusCode int) *ResponseData

+ type ResponseDataStructDecoder interface

+ Decode func(response any) ([]byte, error)

+ type ResponseHeader struct

+ func NewHeader(name, value string) *ResponseHeader

+ type RestRespStatusStruct struct

+ BizErrorCode *BizErrorCode

+ BizErrorMessage *BizErrorMessage

+ StatusCode StatusCode

+ StatusMessage StatusMessage

+ Timestamp int64

+ type RestRespStruct struct

+ Data any

+ Status *RestRespStatusStruct

+ type Router interface

+ Handlers func(router *RouterWrapper)

+ Info func() *RouterInfo

+ type RouterInfo struct

+ BasicAuthAccount *BasicAuthAccount

+ GroupPath string

+ type RouterWrapper struct

+ func (r *RouterWrapper) DELETE(path string, handler ...HandlerWrapper)

+ func (r *RouterWrapper) GET(path string, handler ...HandlerWrapper)

+ func (r *RouterWrapper) HEAD(path string, handler ...HandlerWrapper)

+ func (r *RouterWrapper) MATCH(method []string, path string, handler ...HandlerWrapper)

+ func (r *RouterWrapper) OPTIONS(path string, handler ...HandlerWrapper)

+ func (r *RouterWrapper) PATCH(path string, handler ...HandlerWrapper)

+ func (r *RouterWrapper) POST(path string, handler ...HandlerWrapper)

+ func (r *RouterWrapper) PUT(path string, handler ...HandlerWrapper)

+ func (r *RouterWrapper) TRACE(path string, handler ...HandlerWrapper)

+ type StatusCode int

+ type StatusMessage string

+ func GetStatusMessage(statusCode StatusCode) StatusMessage