Categorygithub.com/go-chi/render

modulepackage

1.0.3

Repository: https://github.com/go-chi/render.git

Documentation: pkg.go.dev

# README

render

The render package helps manage HTTP request / response payloads.

Every well-designed, robust and maintainable Web Service / REST API also needs well-defined request and response payloads. Together with the endpoint handlers, the request and response payloads make up the contract between your server and the clients calling on it.

Typically in a REST API application, you will have your data models (objects/structs) that hold lower-level runtime application state, and at times you need to assemble, decorate, hide or transform the representation before responding to a client. That server output (response payload) structure, is also likely the input structure to another handler on the server.

This is where render comes in - offering a few simple helpers and interfaces to provide a simple pattern for managing payload encoding and decoding.

We've also combined it with some helpers for responding to content types and parsing request bodies. Please have a look at the rest example which uses the latest chi/render sub-pkg.

All feedback is welcome, thank you!

# Functions

Bind

Bind decodes a request body and executes the Binder method of the payload structure.

Data

Data writes raw bytes to the response, setting the Content-Type as application/octet-stream.

DecodeForm

DecodeForm decodes a given reader into an interface using the form decoder.

DecodeJSON

DecodeJSON decodes a given reader into an interface using the json decoder.

DecodeXML

DecodeXML decodes a given reader into an interface using the xml decoder.

DefaultDecoder

DefaultDecoder detects the correct decoder for use on an HTTP request and marshals into a given interface.

DefaultResponder

Respond handles streaming JSON and XML responses, automatically setting the Content-Type based on request headers.

GetAcceptedContentType

No description provided by the author

GetContentType

No description provided by the author

GetRequestContentType

GetRequestContentType is a helper function that returns ContentType based on context or request headers.

HTML

HTML writes a string to the response, setting the Content-Type as text/html.

JSON

JSON marshals 'v' to JSON, automatically escaping HTML and setting the Content-Type as application/json.

NoContent

NoContent returns a HTTP 204 "No Content" response.

PlainText

PlainText writes a string to the response, setting the Content-Type as text/plain.

Render

Render renders a single payload and respond to the client request.

RenderList

RenderList renders a slice of payloads and responds to the client request.

SetContentType

SetContentType is a middleware that forces response Content-Type.

Status

Status sets a HTTP response status code hint into request context at any point during the request life-cycle.

XML

XML marshals 'v' to XML, setting the Content-Type as application/xml.