httpapi

Documentation

Index

• func Forbidden(rw http.ResponseWriter)
• func Read(rw http.ResponseWriter, r *http.Request, value interface{}) bool
• func WebsocketCloseSprintf(format string, vars ...any) string
• func Write(rw http.ResponseWriter, status int, response interface{})
• type Error
• type Response

Functions

func Forbidden

func Forbidden(rw http.ResponseWriter)

func Read

func Read(rw http.ResponseWriter, r *http.Request, value interface{}) bool

Read decodes JSON from the HTTP request into the value provided. It uses go-validator to validate the incoming request body.

func WebsocketCloseSprintf

func WebsocketCloseSprintf(format string, vars ...any) string

WebsocketCloseSprintf formats a websocket close message and ensures it is truncated to the maximum allowed length.

func Write

func Write(rw http.ResponseWriter, status int, response interface{})

Write outputs a standardized format to an HTTP response body.

Types

type Error

type Error struct {
	Field  string `json:"field" validate:"required"`
	Detail string `json:"detail" validate:"required"`
}

Error represents a scoped error to a user input.

type Response

type Response struct {
	Message string  `json:"message" validate:"required"`
	Errors  []Error `json:"errors,omitempty" validate:"required"`
}

Response represents a generic HTTP response.