httputil

Documentation

Index

• func BindData(c *gin.Context, data interface{}) (int, error)
• func FetchErrorHandler(c *gin.Context, err error)
• func NewError(c *gin.Context, status int, err error)
• func OptionsGet(c *gin.Context)
• func OptionsGetPatchDelete(c *gin.Context)
• func OptionsGetPost(c *gin.Context)
• func ParseID(c *gin.Context, param string) (uint64, error)
• func RequestHost(c *gin.Context) string
• func RequestPathV1(c *gin.Context) string
• func RequestURL(c *gin.Context) string
• type HTTPError

Functions

func BindData

func BindData(c *gin.Context, data interface{}) (int, error)

BindData binds the data from the request to the struct passed in the interface.

func FetchErrorHandler

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

FetchErrorHandler handles errors for fetching data from the database.

func NewError

func NewError(c *gin.Context, status int, err error)

NewError creates an HTTPError instance and returns it.

func OptionsGet

func OptionsGet(c *gin.Context)

func OptionsGetPatchDelete

func OptionsGetPatchDelete(c *gin.Context)

func OptionsGetPost

func OptionsGetPost(c *gin.Context)

func ParseID

func ParseID(c *gin.Context, param string) (uint64, error)

ParseID parses the ID.

func RequestHost

func RequestHost(c *gin.Context) string

The scheme defaults to https and only falls back to http if the x-forwarded-proto header is set to "http".

func RequestPathV1

func RequestPathV1(c *gin.Context) string

RequestPathV1 returns the URL with the prefix for API v1.

func RequestURL

func RequestURL(c *gin.Context) string

RequestURL returns the full request URL.

Types

type HTTPError

type HTTPError struct {
	Error string `json:"error" example:"An ID specified in the query string was not a valid uint64"`
}

HTTPError is used for error responses that contain a body.