v2

Documentation

Index

• Constants
• func EncodeQuery(param map[string]string) string
• func ErrorHandleMiddleware() gin.HandlerFunc
• func JsonResponse(c *gin.Context, httpCode int, code int, obj any)
• func RegisterCRUDApi(route *gin.Engine, pathPrefix string, api CRUDApi, ...)
• func Response(c *gin.Context, obj any)
• func ResponseError(c *gin.Context, err error)
• type CRUDApi
• type Code
  • func NewCode(code int, httpStatus int) *Code
• type ErrorResponse
  • func NewErrorResponse() *ErrorResponse
  • func (r *ErrorResponse) WithError(err error) *ErrorResponse
  • func (r *ErrorResponse) WriteResponse(ctx *gin.Context)
• type Middleware

Constants

const (
	Success = "success"
	Error   = "error"
	Status  = "status"
)

Functions

func EncodeQuery

func EncodeQuery(param map[string]string) string

func ErrorHandleMiddleware

func ErrorHandleMiddleware() gin.HandlerFunc

func JsonResponse

func JsonResponse(c *gin.Context, httpCode int, code int, obj any)

func RegisterCRUDApi

func RegisterCRUDApi(route *gin.Engine, pathPrefix string, api CRUDApi, middlewares ...gin.HandlerFunc)

func Response

func Response(c *gin.Context, obj any)

func ResponseError

func ResponseError(c *gin.Context, err error)

Types

type CRUDApi

type CRUDApi interface {
	Get(c *gin.Context)
	List(c *gin.Context)
	Create(c *gin.Context)
	Update(c *gin.Context)
	Delete(c *gin.Context)
}

type Code

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

func NewCode

func NewCode(code int, httpStatus int) *Code

type ErrorResponse

type ErrorResponse struct {
	HttpStatus int

	// in: body
	Payload struct {
		// error code
		Code int `json:"code"`
		// error message
		Message string `json:"message"`
	} `json:"body"`
	// contains filtered or unexported fields
}

swagger:response errorResponse

func NewErrorResponse

func NewErrorResponse() *ErrorResponse

func (*ErrorResponse) WithError

func (r *ErrorResponse) WithError(err error) *ErrorResponse

func (*ErrorResponse) WriteResponse

func (r *ErrorResponse) WriteResponse(ctx *gin.Context)

type Middleware

type Middleware interface {
	Apply(next http.Handler) http.Handler
}