handler

Documentation

Index

• Constants
• func FailureRender(ctx context.Context, w http.ResponseWriter, r *http.Request, err error) error
• func FailureWithCodeRender(ctx context.Context, w http.ResponseWriter, r *http.Request, err error, ...) error
• func HandleResult(w http.ResponseWriter, r *http.Request, ctx context.Context, err error, ...)
• func NotFoundRender(ctx context.Context, w http.ResponseWriter, r *http.Request, err error) error
• func Response(ctx context.Context, data any, err error, statusCode int) render.Renderer
• func SuccessRender(ctx context.Context, w http.ResponseWriter, r *http.Request, data any)
• type Duration
  • func (d Duration) MarshalJSON() (b []byte, err error)
• type Payload

Constants

const SuccessMessage = "OK"

SuccessMessage is the default success message for successful responses.

Functions

func FailureRender

func FailureRender(ctx context.Context, w http.ResponseWriter, r *http.Request, err error) error

FailureRender renders a failed response and status code and respond to the client request.

func FailureWithCodeRender

func FailureWithCodeRender(ctx context.Context, w http.ResponseWriter, r *http.Request, err error, statusCode int) error

FailureWithCodeRender renders a failed response and custom status code and respond to the client request.

func HandleResult

func HandleResult(w http.ResponseWriter, r *http.Request, ctx context.Context, err error, data any)

HandleResult is a handler function that writes the response to the HTTP response writer based on the provided error and data.

func NotFoundRender

func NotFoundRender(ctx context.Context, w http.ResponseWriter, r *http.Request, err error) error

NotFoundRender renders a not found response and status code and respond to the client request.

func Response

func Response(ctx context.Context, data any, err error, statusCode int) render.Renderer

Response creates a standard API response renderer.

func SuccessRender

func SuccessRender(ctx context.Context, w http.ResponseWriter, r *http.Request, data any)

SuccessRender renders a success response and status code and respond to the client request.

Types

type Duration

type Duration time.Duration

Duration is a custom type that represents a duration of time.

func (Duration) MarshalJSON

func (d Duration) MarshalJSON() (b []byte, err error)

MarshalJSON customizes JSON representation of the Duration type.

type Payload

type Payload interface {
	Decode(*http.Request) error // Decode returns the payload object with the decoded
}

Payload is an interface for incoming requests payloads Each handler should implement this interface to parse payloads