mrresponse

Documentation

Index

• Constants
• func HandlerGetMethodNotAllowedAsJson() func(w http.ResponseWriter, r *http.Request)
• func HandlerGetNotFoundAsJson() func(w http.ResponseWriter, r *http.Request)
• func HandlerGetSystemInfoAsJson(cfg SystemInfoConfig) (func(w http.ResponseWriter, r *http.Request), error)
• type ErrorAttribute
• type ErrorDetailsResponse
• type ErrorListResponse
• type ErrorSender
  • func NewErrorSender(encoder mrserver.ResponseEncoder) *ErrorSender
  • func NewErrorSenderWithOverrideFunc(encoder mrserver.ResponseEncoder, overrideFunc mrserver.HttpErrorOverrideFunc) *ErrorSender
  • func (rs *ErrorSender) SendError(w http.ResponseWriter, r *http.Request, err error)
• type FileSender
  • func NewFileSender(base *Sender) *FileSender
  • func (rs *FileSender) SendAttachmentFile(ctx context.Context, w http.ResponseWriter, file mrtype.File) error
  • func (rs *FileSender) SendFile(ctx context.Context, w http.ResponseWriter, file mrtype.File) error
• type Sender
  • func NewSender(encoder mrserver.ResponseEncoder) *Sender
  • func (rs *Sender) Send(w http.ResponseWriter, status int, structure any) error
  • func (rs *Sender) SendBytes(w http.ResponseWriter, status int, body []byte) error
  • func (rs *Sender) SendNoContent(w http.ResponseWriter) error
• type SuccessCreatedItemResponse
• type SuccessModifyItemResponse
• type SystemInfoConfig

Constants

const (
	ErrorAttributeIDByDefault = "generalError"
)

Functions

func HandlerGetMethodNotAllowedAsJson

func HandlerGetMethodNotAllowedAsJson() func(w http.ResponseWriter, r *http.Request)

func HandlerGetNotFoundAsJson

func HandlerGetNotFoundAsJson() func(w http.ResponseWriter, r *http.Request)

func HandlerGetSystemInfoAsJson

func HandlerGetSystemInfoAsJson(cfg SystemInfoConfig) (func(w http.ResponseWriter, r *http.Request), error)

Types

type ErrorAttribute

type ErrorAttribute struct {
	ID        string `json:"id"`
	Value     string `json:"value"`
	DebugInfo string `json:"debugInfo,omitempty"`
}

type ErrorDetailsResponse

type ErrorDetailsResponse struct {
	Title        string `json:"title"`
	Details      string `json:"details"`
	Request      string `json:"request"`
	Time         string `json:"time"`
	ErrorTraceID string `json:"errorTraceId,omitempty"`
}

ErrorDetailsResponse - application/problem+json (401, 403, 404, 418, 5XX)

type ErrorListResponse

type ErrorListResponse []ErrorAttribute

ErrorListResponse - application/json (400)

type ErrorSender

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

func NewErrorSender

func NewErrorSender(encoder mrserver.ResponseEncoder) *ErrorSender

func NewErrorSenderWithOverrideFunc

func NewErrorSenderWithOverrideFunc(
	encoder mrserver.ResponseEncoder,
	overrideFunc mrserver.HttpErrorOverrideFunc,
) *ErrorSender

func (*ErrorSender) SendError

func (rs *ErrorSender) SendError(w http.ResponseWriter, r *http.Request, err error)

type FileSender

type FileSender struct {
	*Sender
}

func NewFileSender

func NewFileSender(base *Sender) *FileSender

func (*FileSender) SendAttachmentFile

func (rs *FileSender) SendAttachmentFile(ctx context.Context, w http.ResponseWriter, file mrtype.File) error

func (*FileSender) SendFile

func (rs *FileSender) SendFile(ctx context.Context, w http.ResponseWriter, file mrtype.File) error

type Sender

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

func NewSender

func NewSender(encoder mrserver.ResponseEncoder) *Sender

func (*Sender) Send

func (rs *Sender) Send(w http.ResponseWriter, status int, structure any) error

func (*Sender) SendBytes

func (rs *Sender) SendBytes(w http.ResponseWriter, status int, body []byte) error

func (*Sender) SendNoContent

func (rs *Sender) SendNoContent(w http.ResponseWriter) error

type SuccessCreatedItemResponse

type SuccessCreatedItemResponse struct {
	ItemID  string `json:"id"`
	Message string `json:"message,omitempty"`
}

type SuccessModifyItemResponse

type SuccessModifyItemResponse struct {
	Message string `json:"message,omitempty"`
}

type SystemInfoConfig

type SystemInfoConfig struct {
	Name      string
	Version   string
	StartedAt time.Time
}