rest

Documentation

Index

• func ExtractUUID(c *gin.Context) (uuid.UUID, error)
• func ExtractUser(c *gin.Context) (uuid.UUID, error)
• type PaginatedMessage
• type Query
  • func ExtractFilters(c *gin.Context, needUser bool) (*Query, error)

Functions

func ExtractUUID

func ExtractUUID(c *gin.Context) (uuid.UUID, error)

ExtractUUID extract UUID from URL parameters

func ExtractUser

func ExtractUser(c *gin.Context) (uuid.UUID, error)

ExtractUser extract and returns a user UUID from gin context

Types

type PaginatedMessage

type PaginatedMessage struct {
	Page  int         `json:"page"`
	Count int         `json:"count"`
	Data  interface{} `json:"data"`
}

PaginatedMessage is a structure which contains standard attributes to be used on paginated services

type Query

type Query struct {
	Page    int
	Limit   int
	Sort    string
	Filters map[string]interface{}
}

Query is structure which contains standard attributes to parse http parameters for API filter, search and pagination

func ExtractFilters

func ExtractFilters(c *gin.Context, needUser bool) (*Query, error)

ExtractFilters can be used to parse query parameters and return a Query object, useful to query, filter and paginate requests