request

Documentation

Index

• Variables
• func Bind[T any](c *gin.Context) (*T, error)
• func BindImportFileRequest[T any](c *gin.Context) ([]T, map[string]string, error)
• func BindJSON[T any](c *gin.Context) (*T, error)
• func BindJSONValue(c *gin.Context, r interface{}) error
• func BindJsonStruct(obj any) error
• func BindQuery[T any](c *gin.Context) (*T, error)
• func BindUri[T any](c *gin.Context) (*T, error)
• func DecodeJSON(r io.Reader, obj any) error
• func Id(c *gin.Context) (int, error)
• func ParseWhere(input string) (*clause.ExpressionWhere, error)
• func TxHandle(c *gin.Context) *gorm.DB
• func UUID(c *gin.Context) (string, error)
• type FilterRequest
  • func Filter(c *gin.Context) (*FilterRequest, error)
  • func FilterJSON(c *gin.Context) (*FilterRequest, error)
• type IdRequest
• type ImportRequest
• type MetaRequest
  • func Meta(c *gin.Context) (*MetaRequest, error)
• type MultipleDeleteRequest
• type MultipleUpdateRequest
• type PaginationRequest
  • func Pagination(c *gin.Context) (*PaginationRequest, error)
• type UUIDRequest

Variables

var (
	ErrorValidationId   = apperr.New("validation_id", apperr.WithTextTranslate(i18n.ErrorValidationId), apperr.WithCode(code.InvalidArgument))
	ErrorValidationUUID = apperr.New("validation_uuid", apperr.WithTextTranslate(i18n.ErrorValidationUUID), apperr.WithCode(code.InvalidArgument))
)

Functions

func Bind

func Bind[T any](c *gin.Context) (*T, error)

func BindImportFileRequest

func BindImportFileRequest[T any](c *gin.Context) ([]T, map[string]string, error)

func BindJSON

func BindJSON[T any](c *gin.Context) (*T, error)

func BindJSONValue

func BindJSONValue(c *gin.Context, r interface{}) error

func BindJsonStruct

func BindJsonStruct(obj any) error

func BindQuery

func BindQuery[T any](c *gin.Context) (*T, error)

func BindUri

func BindUri[T any](c *gin.Context) (*T, error)

func DecodeJSON

func DecodeJSON(r io.Reader, obj any) error

func Id

func Id(c *gin.Context) (int, error)

func ParseWhere

func ParseWhere(input string) (*clause.ExpressionWhere, error)

func TxHandle

func TxHandle(c *gin.Context) *gorm.DB

func UUID

func UUID(c *gin.Context) (string, error)

Types

type FilterRequest

type FilterRequest struct {
	OrderBy []clause.ExpressionOrderBy
	Where   *clause.ExpressionWhere
}

func Filter

func Filter(c *gin.Context) (*FilterRequest, error)

func FilterJSON

func FilterJSON(c *gin.Context) (*FilterRequest, error)

type IdRequest

type IdRequest struct {
	Id int `uri:"id" binding:"required,gte=1"`
}

type ImportRequest

type ImportRequest struct {
	CSV *multipart.FileHeader `form:"csv" binding:"required"`
}

type MetaRequest

type MetaRequest struct {
	*PaginationRequest
	*FilterRequest
}

func Meta

func Meta(c *gin.Context) (*MetaRequest, error)

type MultipleDeleteRequest

type MultipleDeleteRequest struct {
	IDs []int `json:"ids" binding:"required,min=1,max=500000,unique"`
}

type MultipleUpdateRequest

type MultipleUpdateRequest[T any] struct {
	IDs  []int `json:"ids" binding:"required,min=1,max=500000,unique"`
	Data T     `json:"data" binding:"required"`
}

type PaginationRequest

type PaginationRequest struct {
	Limit               int  `form:"limit" binding:"omitempty"`
	Offset              int  `form:"offset" binding:"omitempty"`
	MustReturnTotalRows bool `form:"count" binding:"omitempty"`
}

func Pagination

func Pagination(c *gin.Context) (*PaginationRequest, error)

type UUIDRequest

type UUIDRequest struct {
	UUID string `uri:"uuid" binding:"required"`
}