httpresponse

Documentation

Index

• type PaginatedResponse
  • func NewEmptyPaginatedResponse() PaginatedResponse
  • func NewPaginatedResponse(r *http.Request, data interface{}, currentPage, pageLimit, totalItems int) (PaginatedResponse, error)
• type PaginationInfo

Types

type PaginatedResponse

type PaginatedResponse struct {
	Pagination PaginationInfo  `json:"pagination"`
	Data       json.RawMessage `json:"data"`
}

PaginatedResponse is a response that contains pagination information.

func NewEmptyPaginatedResponse

func NewEmptyPaginatedResponse() PaginatedResponse

NewEmptyPaginatedResponse returns a PaginatedResponse with an empty data and 0 pages.

This is useful for returning an empty list.

func NewPaginatedResponse

func NewPaginatedResponse(r *http.Request, data interface{}, currentPage, pageLimit, totalItems int) (PaginatedResponse, error)

NewPaginatedResponse returns a PaginatedResponse with pagination information.

type PaginationInfo

type PaginationInfo struct {
	Next  string `json:"next,omitempty"`
	Prev  string `json:"prev,omitempty"`
	Pages int    `json:"pages"`
	Total int    `json:"total"`
}