/
doc.go
16 lines (15 loc) · 883 Bytes
/
doc.go
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
// Copyright (c) 2016 John Jeffery. All rights reserved.
// Package httpapi provides assistance for servers that implement a JSON Web API.
// It has no pretensions to be a framework: it is intended to work with the standard
// library HTTP handlers. The goal is to provide simple primitives for reading
// input from HTTP requests and writing output to the HTTP response writer.
//
// The package supports compressing responses if the client can support it. It also
// provides non-standard support for clients compressing the body of requests. See
// the ReadRequest function for more details.
//
// The WriteError function provides a simple, consistent way to send error messages
// to HTTP clients. It has some sensible defaults for the format and handling of JSON
// error messages, but can be customized. See the writeerror subdirectory package for
// details.
package httpapi