web

Documentation

Overview

Package web contains a small web framework extension.

Index

• func NewAPIKey(length int) (string, error)
• func Respond(ctx context.Context, w http.ResponseWriter, data any, statusCode int)
• type ErrorResponse
  • func NewErrorResponse(message string) ErrorResponse
• type Handler

Functions

func NewAPIKey

func NewAPIKey(length int) (string, error)

NewAPIKey is a factory function to create an api key with a specified length betweend 30 and 128 characters.

func Respond

func Respond(ctx context.Context, w http.ResponseWriter, data any, statusCode int)

Respond converts a Go value to JSON and sends it to the client.

Types

type ErrorResponse

type ErrorResponse struct {
	Message string `json:"error"`
}

func NewErrorResponse

func NewErrorResponse(message string) ErrorResponse

type Handler

type Handler func(ctx context.Context, w http.ResponseWriter, r *http.Request) error

A Handler is a type that handles a http request within our small framework