README
¶
REST helpers and middleware 
Install and update
go get -u github.com/go-pkgz/rest
Middlewares
AppInfo middleware
Adds info to every response header:
- App-Name - application name
- App-Version - application version
- Org - organization
- M-Host - host name from instance-level
$MHOSTenv
Ping-Pong middleware
Responds with pong on GET /ping. Also responds to anything with /ping suffix, like /v2/ping
example for both:
> http GET https://remark42.radio-t.com/ping
HTTP/1.1 200 OK
Date: Sun, 15 Jul 2018 19:40:31 GMT
Content-Type: text/plain
Content-Length: 4
Connection: keep-alive
App-Name: remark42
App-Version: master-ed92a0b-20180630-15:59:56
Org: Umputun
pong
Logger middleware
Logs all info about request, including user, method, status code, response size, url, elapsed time, request body (optional). Can be customized by passing flags - LogNone, LogAll, LogUser and LogBody. Flags can be combined (provided multiple times)
Recoverer middleware
Recoverer is a middleware that recovers from panics, logs the panic (and a backtrace), and returns a HTTP 500 (Internal Server Error) status if possible.
Helpers
rest.JSON- map alias, just for conveniencetype JSON map[string]interface{}rest.RenderJSONFromBytes- renders json response from []byterest.RenderJSONWithHTML- renders json response with html tags and forcedcharset=utf-8rest.SendErrorJSON- makes{error: blah, details: blah}json body and responds with given error code. Also adds context to logged message
Documentation
¶
Index ¶
- func AppInfo(app string, org string, version string) func(http.Handler) http.Handler
- func Ping(next http.Handler) http.Handler
- func Recoverer(next http.Handler) http.Handler
- func RenderJSONFromBytes(w http.ResponseWriter, r *http.Request, data []byte) error
- func RenderJSONWithHTML(w http.ResponseWriter, r *http.Request, v interface{}) error
- func SendErrorJSON(w http.ResponseWriter, r *http.Request, code int, err error, details string)
- type JSON
Constants ¶
This section is empty.
Variables ¶
This section is empty.
Functions ¶
func Recoverer ¶
Recoverer is a middleware that recovers from panics, logs the panic and returns a HTTP 500 status if possible.
func RenderJSONFromBytes ¶
RenderJSONFromBytes sends binary data as json
func RenderJSONWithHTML ¶
func RenderJSONWithHTML(w http.ResponseWriter, r *http.Request, v interface{}) error
RenderJSONWithHTML allows html tags and forces charset=utf-8
func SendErrorJSON ¶
SendErrorJSON makes {error: blah, details: blah} json body and responds with error code
Source Files
Directories