render

package

v2.10.1 Latest Latest Go to latest Published: Feb 12, 2024 License: MIT Imports: 4 Imported by: 1

Details

Valid go.mod file

The Go module system was introduced in Go 1.11 and is the official dependency management solution for Go.
Redistributable license

Redistributable licenses place minimal restrictions on how software can be used, modified, and redistributed.
Tagged version

Modules with tagged versions give importers more predictable builds.
Stable version

When a project reaches major version v1 it is considered stable.
Learn more about best practices

Repository

github.com/hamba/pkg

Links

Open Source Insights

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 ¶

View Source

const JSONContentType = "application/json"

JSONContentType represents MIME type for JSON content.

Variables ¶

This section is empty.

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.

Source Files ¶

View all Source files

json.go

?	: This menu
/	: Search site
f or F	: Jump to
y or Y	: Canonical URL