http

Documentation

Index

• Constants
• func ServeFile(c *gin.Context, code int, filename string, content []byte)
• type PaginatedItemsResponse
• type Pagination
  • func ParsePagination(c *gin.Context) (*Pagination, error)
  • func (p *Pagination) ToLimit() query.Limit
• type QueryFilter
  • func ParseQueryFilter(c *gin.Context) (QueryFilter, error)
• type ResponseInterceptor
  • func (w *ResponseInterceptor) GetBody() []byte
  • func (w *ResponseInterceptor) Intercept(ctx *gin.Context)
  • func (w *ResponseInterceptor) Stop(ctx *gin.Context)
  • func (w *ResponseInterceptor) Write(p []byte) (n int, err error)

Constants

const (
	Pagination_Offset string = "offset"
	Pagination_Limit  string = "limit"

	DefaultLimit uint64 = 10
)

Functions

func ServeFile

func ServeFile(c *gin.Context, code int, filename string, content []byte)

ServeFile is a variation of the Gin Web Framework FileAttachment to support serving of a file for download from a []byte. https://github.com/gin-gonic/gin/blob/v1.10.0/context.go#L1097

Types

type PaginatedItemsResponse

type PaginatedItemsResponse struct {
	Items      json.RawMessage `json:"items"`
	Pagination Pagination      `json:"pagination"`
}

type Pagination

type Pagination struct {
	Offset uint64 `json:"offset"`
	Limit  uint64 `json:"limit"`
	Total  int64  `json:"total"`
}

TODO(slax0rr): Move to a more appropriate location, having it in infra is not appropriate with the onion architecture but is being kept here for the purposes of quicker delivery.

func ParsePagination

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

func (*Pagination) ToLimit

func (p *Pagination) ToLimit() query.Limit

type QueryFilter

type QueryFilter = map[string][]string

TODO(slax0rr): Move to a more appropriate location, having it in infra is not appropriate with the onion architecture but is being kept here for the purposes of quicker delivery.

func ParseQueryFilter

func ParseQueryFilter(c *gin.Context) (QueryFilter, error)

type ResponseInterceptor

type ResponseInterceptor struct {
	gin.ResponseWriter

	Rewrite bool
	// contains filtered or unexported fields
}

func (*ResponseInterceptor) GetBody

func (w *ResponseInterceptor) GetBody() []byte

func (*ResponseInterceptor) Intercept

func (w *ResponseInterceptor) Intercept(ctx *gin.Context)

func (*ResponseInterceptor) Stop

func (w *ResponseInterceptor) Stop(ctx *gin.Context)

func (*ResponseInterceptor) Write

func (w *ResponseInterceptor) Write(p []byte) (n int, err error)