request

Documentation

Index

• Constants
• func APIError(ctx *gin.Context, kErr *error.KafkaError)
• func APISuccess(ctx *gin.Context, response interface{})
• func GetRequestID(ctx *gin.Context) string
• type Meta
• type Response

Constants

const (
	// MetaKey meta
	MetaKey = "meta"
	// RequestIDKey request_id
	RequestIDKey = "request_id"
)

Functions

func APIError

func APIError(ctx *gin.Context, kErr *error.KafkaError)

APIError http request error

func APISuccess

func APISuccess(ctx *gin.Context, response interface{})

APISuccess http request success

func GetRequestID

func GetRequestID(ctx *gin.Context) string

GetRequestID get current request id

Types

type Meta

type Meta struct {
	Code       int64  `json:"code"`        //error code, if succeed return 0
	Error      string `json:"error"`       //error for developer
	RequestID  string `json:"request_id"`  //request id
	RequestURI string `json:"request_uri"` //request uri
}

Meta struct

type Response

type Response struct {
	Meta Meta        `json:"meta"`     //response meta
	Body interface{} `json:"response"` //response body
}

Response struct