api

Documentation

Index

• func WriteError(ctx context.Context, w http.ResponseWriter, error AppError, l *zap.Logger)
• func WriteSuccess(ctx context.Context, w http.ResponseWriter, success interface{}, status int, ...)
• type AppError
  • func (e AppError) SetMessage(msg string) *AppError
• type Error
• type Success

Functions

func WriteError

func WriteError(ctx context.Context, w http.ResponseWriter, error AppError, l *zap.Logger)

func WriteSuccess

func WriteSuccess(ctx context.Context, w http.ResponseWriter, success interface{}, status int, l *zap.Logger)

Types

type AppError

type AppError struct {
	// Наименование ошибки
	Name string `json:"name" validate:"required" example:"NotFound"`
	// Сообщение ошибки
	Message string `json:"message" validate:"required" example:"entity not found"`
	// Код ошибки
	Code int `json:"code" validate:"required" example:"26002"`
	// Статус код ответа
	Status int `json:"status" validate:"required" example:"404"`

} //	@AppError

func (AppError) SetMessage

func (e AppError) SetMessage(msg string) *AppError

type Error

type Error struct {
	Status    string   `json:"status"`
	Error     AppError `json:"error"`
	RequestID string   `json:"request_id"`
}

type Success

type Success struct {
	Status    string      `json:"status"`
	Content   interface{} `json:"content"`
	RequestID string      `json:"request_id"`
}