# README

chi/render

The render sub-package helps manage HTTP request / response payloads.

Every a well-designed, robust and maintainable Web Service / REST API also needs well-defined request and response payloads.

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, and also the client will likely provide the same structure as input from its requests.

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.

DecodeJSON

No description provided by the author

DecodeXML

No description provided by the author

DefaultDecoder

No description provided by the author

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 JSON, setting the Content-Type as application/xml.