response

Documentation

Index

• func AuthenticationErrors(ctx *gin.Context, message string)
• func BadRequestErrors(ctx *gin.Context, err *errs.ClientError)
• func BasicAuthErrors(ctx *gin.Context, message string)
• func BindErrors(ctx *gin.Context, err error)
• func FormErrors(ctx *gin.Context, code errs.MainErrorCode, message string)
• func Success(ctx *gin.Context, message string, data interface{})
• type Response

Functions

func AuthenticationErrors

func AuthenticationErrors(ctx *gin.Context, message string)

AuthenticationErrors sets authentication error response. Returns 401.

func BadRequestErrors

func BadRequestErrors(ctx *gin.Context, err *errs.ClientError)

BadRequestErrors sets response for invalid or bad request like validation errors. Returns 400.

func BasicAuthErrors

func BasicAuthErrors(ctx *gin.Context, message string)

BasicAuthErrors sets basic auth error response. Returns 401.

func BindErrors

func BindErrors(ctx *gin.Context, err error)

BindErrors sets binding error response. Returns 400.

Gin form binding returns different types of errors. (ValidationErrors, NumError, etc.)

https://github.com/gin-gonic/gin/issues/1093

func FormErrors

func FormErrors(ctx *gin.Context, code errs.MainErrorCode, message string)

FormErrors sets form error response. Returns 400.

func Success

func Success(ctx *gin.Context, message string, data interface{})

Success sets a success response. Returns 200.

Types

type Response

type Response struct {
	Errors  []errs.ClientError `json:"errors,omitempty"`
	Message string             `json:"message,omitempty"`
	Data    interface{}        `json:"data,omitempty"`
}

Response is a REST endpoint response.