utils

Documentation

Index

• Variables
• func AuthenticationRequiredResponse(w http.ResponseWriter, r *http.Request, logger *slog.Logger)
• func BadRequestResponse(w http.ResponseWriter, r *http.Request, logger *slog.Logger, err error)
• func EditConflictResponse(w http.ResponseWriter, r *http.Request, logger *slog.Logger)
• func ErrorResponse(w http.ResponseWriter, r *http.Request, logger *slog.Logger, status int, ...)
• func FailedValidationResponse(w http.ResponseWriter, r *http.Request, logger *slog.Logger, ...)
• func InvalidAuthenticationTokenResponse(w http.ResponseWriter, r *http.Request, logger *slog.Logger)
• func LogError(r *http.Request, logger *slog.Logger, err error)
• func MethodNotAllowedResponse(w http.ResponseWriter, r *http.Request, logger *slog.Logger)
• func NotFoundResponse(w http.ResponseWriter, r *http.Request, logger *slog.Logger)
• func RateLimitExceededResponse(w http.ResponseWriter, r *http.Request, logger *slog.Logger)
• func ReadIDParam(r *http.Request) (int64, error)
• func ReadJSON(w http.ResponseWriter, r *http.Request, dst any) error
• func ServerErrorResponse(w http.ResponseWriter, r *http.Request, logger *slog.Logger, err error)
• func WriteJSON(w http.ResponseWriter, status int, data Envelope, headers http.Header) error
• type Envelope

Variables

var (
	ErrRecordNotFound = errors.New("record not found")
	ErrEditConflict   = errors.New("edit conflict")
)

Functions

func AuthenticationRequiredResponse

func AuthenticationRequiredResponse(w http.ResponseWriter, r *http.Request, logger *slog.Logger)

func BadRequestResponse

func BadRequestResponse(w http.ResponseWriter, r *http.Request, logger *slog.Logger, err error)

func EditConflictResponse

func EditConflictResponse(w http.ResponseWriter, r *http.Request, logger *slog.Logger)

func ErrorResponse

func ErrorResponse(w http.ResponseWriter, r *http.Request, logger *slog.Logger, status int, message any)

func FailedValidationResponse

func FailedValidationResponse(w http.ResponseWriter, r *http.Request, logger *slog.Logger, errors map[string]string)

func InvalidAuthenticationTokenResponse

func InvalidAuthenticationTokenResponse(w http.ResponseWriter, r *http.Request, logger *slog.Logger)

func LogError

func LogError(r *http.Request, logger *slog.Logger, err error)

func MethodNotAllowedResponse

func MethodNotAllowedResponse(w http.ResponseWriter, r *http.Request, logger *slog.Logger)

func NotFoundResponse

func NotFoundResponse(w http.ResponseWriter, r *http.Request, logger *slog.Logger)

func RateLimitExceededResponse

func RateLimitExceededResponse(w http.ResponseWriter, r *http.Request, logger *slog.Logger)

func ReadIDParam

func ReadIDParam(r *http.Request) (int64, error)

Retrieve the "id" URL parameter from the current request context, then convert it to an integer and return it. If the operation isn't successful, return 0 and an error.

func ReadJSON

func ReadJSON(w http.ResponseWriter, r *http.Request, dst any) error

func ServerErrorResponse

func ServerErrorResponse(w http.ResponseWriter, r *http.Request, logger *slog.Logger, err error)

func WriteJSON

func WriteJSON(w http.ResponseWriter, status int, data Envelope, headers http.Header) error

Define a writeJSON() helper for sending responses. This takes the destination http.ResponseWriter, the HTTP status code to send, the data to encode to JSON, and a header map containing any additional HTTP headers we want to include in the response.

Types

type Envelope

type Envelope map[string]any