render

Documentation

Overview

Package render provides HTTP output rendering helper functions.

Index

• Constants
• func JSON(rw http.ResponseWriter, code int, v any) error
• func JSONError(rw http.ResponseWriter, code int, reason string)
• func JSONErrorf(rw http.ResponseWriter, code int, format string, args ...any)
• func JSONInternalServerError(rw http.ResponseWriter)
• type APIError

Constants

const JSONContentType = "application/json"

JSONContentType represents MIME type for JSON content.

Functions

func JSON

func JSON(rw http.ResponseWriter, code int, v any) error

JSON writes a JSON response.

func JSONError

func JSONError(rw http.ResponseWriter, code int, reason string)

JSONError writes a JSON error message.

func JSONErrorf

func JSONErrorf(rw http.ResponseWriter, code int, format string, args ...any)

JSONErrorf writes a JSON error message.

func JSONInternalServerError

func JSONInternalServerError(rw http.ResponseWriter)

JSONInternalServerError writes a JSON internal server error.

Types

type APIError

type APIError struct {
	// Code is the http status code.
	Code int `json:"code"`

	// Error is the reason for the error.
	Error string `json:"error"`
}

APIError contains error information that is rendered by JSONError.