response

Documentation

Index

• type Config
• type Default
  • func New(render *render.Render) *Default
  • func (t *Default) WriteJSON(w http.ResponseWriter, r *http.Request, statusCode int, res any)
  • func (t *Default) WriteJSONError(w http.ResponseWriter, r *http.Request, err error)
• type MockWriter
  • func NewMockWriter(t interface{ ... }) *MockWriter
  • func (_m *MockWriter) WriteJSON(w http.ResponseWriter, r *http.Request, statusCode int, res interface{})
  • func (_m *MockWriter) WriteJSONError(w http.ResponseWriter, r *http.Request, err error)
• type Writer
  • func Init(cfg Config) Writer

Types

type Config

type Config struct {
	PrettyRender bool `mapstructure:"prettyRender"`
}

type Default

type Default struct {
	// contains filtered or unexported fields
}

Default is used to write the response into an http.ResponseWriter and log the error.

func New

func New(render *render.Render) *Default

New return a new Default.

func (*Default) WriteJSON

func (t *Default) WriteJSON(w http.ResponseWriter, r *http.Request, statusCode int, res any)

Write the given res as a json body and statusCode.

func (*Default) WriteJSONError

func (t *Default) WriteJSONError(w http.ResponseWriter, r *http.Request, err error)

WriteJSONError write the given error into the ResponseWriter.

type MockWriter

type MockWriter struct {
	mock.Mock
}

MockWriter is an autogenerated mock type for the Writer type

func NewMockWriter

func NewMockWriter(t interface {
	mock.TestingT
	Cleanup(func())
}) *MockWriter

NewMockWriter creates a new instance of MockWriter. It also registers a testing interface on the mock and a cleanup function to assert the mocks expectations. The first argument is typically a *testing.T value.

func (*MockWriter) WriteJSON

func (_m *MockWriter) WriteJSON(w http.ResponseWriter, r *http.Request, statusCode int, res interface{})

WriteJSON provides a mock function with given fields: w, r, statusCode, res

func (*MockWriter) WriteJSONError

func (_m *MockWriter) WriteJSONError(w http.ResponseWriter, r *http.Request, err error)

WriteJSONError provides a mock function with given fields: w, r, err

type Writer

type Writer interface {
	WriteJSON(w http.ResponseWriter, r *http.Request, statusCode int, res any)
	WriteJSONError(w http.ResponseWriter, r *http.Request, err error)
}

func Init

func Init(cfg Config) Writer