core

Documentation

Overview

Package core implements some core functions used by apimachinery.

Index

• func WriteResponse(c *gin.Context, err error, data interface{})
• type ErrResponse

Functions

func WriteResponse

func WriteResponse(c *gin.Context, err error, data interface{})

WriteResponse write an error or the response data into http response body. It use errors.ParseCoder to parse any error into errors.Coder errors.Coder contains error code, user-safe error message and http status code.

Types

type ErrResponse

type ErrResponse struct {
	Code      int    `json:"code"`
	Message   string `json:"message"`
	Reference string `json:"reference,omitempty"`
}

ErrResponse defines the return messages when an error occurred. reference will be omitted if it does not exist.