core

Documentation

Index

• func WriteResponse(c *gin.Context, detail interface{}, opts ...Option)
• type ErrResponse
• type Option
  • func WithAbort() Option
  • func WithError(err error) Option
  • func WithHttpStatus(httpStatus int) Option
  • func WithMessage(message string) Option

Functions

func WriteResponse

func WriteResponse(c *gin.Context, detail interface{}, opts ...Option)

WriteResponse 将错误或响应数据写入http响应主体。 它使用 errors.ParseCoder 将任何错误解析为 errors.Coder errors.Coder 包含错误代码、用户安全错误消息和 http 状态代码。

Types

type ErrResponse

type ErrResponse struct {
	// ErrCode 定义业务错误代码。
	ErrCode int `json:"err_code"`

	// Message 包含此消息的详细信息。
	// 此消息适合暴露于外部
	Message string `json:"message"`

	// Detail 返回可能对解决此错误有用的详细信息。
	Detail interface{} `json:"detail,omitempty"`
}

ErrResponse 定义发生错误时的返回消息。

type Option

type Option func(*response)

func WithAbort

func WithAbort() Option

func WithError

func WithError(err error) Option

func WithHttpStatus

func WithHttpStatus(httpStatus int) Option

func WithMessage

func WithMessage(message string) Option