helper

Documentation

Index

• func OAPIErrorHandler(w http.ResponseWriter, r *http.Request, err error)
• func RenderError(err error, w http.ResponseWriter, r *http.Request) error
• func RenderSuccess(w http.ResponseWriter, r *http.Request, v Renderer)
• type ErrResponse
  • func (e ErrResponse) Render(w http.ResponseWriter, _ *http.Request) error
• type ErrStatus
• type Renderer

Functions

func OAPIErrorHandler

func OAPIErrorHandler(w http.ResponseWriter, r *http.Request, err error)

OAPIErrorHandler renders a response when OAPI error has occurred.

func RenderError

func RenderError(err error, w http.ResponseWriter, r *http.Request) error

func RenderSuccess

func RenderSuccess(w http.ResponseWriter, r *http.Request, v Renderer)

RenderSuccess default render method for chi

Types

type ErrResponse

type ErrResponse struct {
	HTTPStatusCode int       `json:"-"`
	Status         ErrStatus `json:"status"`
}

ErrResponse is the HTTP response that reporting an error.

func (ErrResponse) Render

func (e ErrResponse) Render(w http.ResponseWriter, _ *http.Request) error

Render default render method for chi

type ErrStatus

type ErrStatus struct {
	Code    string `json:"code"`
	Message string `json:"message,omitempty"`
}

ErrStatus is the HTTP response body that reporting an error.

type Renderer

type Renderer interface {
	Render(w http.ResponseWriter, r *http.Request) error
}