README
¶
goa Middlewares
This repository contains middlewares for the goa web application framework.
The middleware package provides middlewares that do not depend on additional packages other than
the ones already used by goa. These middlewares provide functionality that is useful to most
microservices:
-
LogRequest enables logging of incoming requests and corresponding responses. The log format is entirely configurable. The default format logs the request HTTP method, path and parameters as well as the corresponding action and controller names. It also logs the request duration and response length. It also logs the request payload if the DEBUG log level is enabled. Finally if the RequestID middleware is mounted LogRequest logs the unique request ID with each log entry.
-
LogResponse logs the content of the response body if the DEBUG log level is enabled.
-
RequestID injects a unique ID in the request context. This ID is used by the logger and can be used by controller actions as well. The middleware looks for the ID in the RequestIDHeader header and if not found creates one.
-
Recover recover panics and logs the panic object and backtrace.
-
Timeout sets a deadline in the request context. Controller actions may subscribe to the context channel to get notified when the timeout expires.
-
RequireHeader checks for the presence of a header in the request with a value matching a given regular expression. If the header is absent or does not match the regexp the middleware sends a HTTP response with a given HTTP status.
Other middlewares listed below are provided as separate Go packages.
JWT
Package jwt contributed by @bketelsen adds the ability for goa services to use JSON Web Token authorization.
CORS
Package cors adds Cross Origin Resource Sharing support to goa services.
Gzip
Package gzip contributed by @tylerb adds the ability to compress response bodies using gzip format as specified in RFC 1952.
Defer Panic
Package dpgoa/middleware contributed by Defer Panic adds the ability for goa services to leverage the Defer Panic service.
Directories
¶
| Path | Synopsis |
|---|---|
|
Package cors provides a goa middleware that implements the Cross-Origin Resource Sharing (CORS) standard as defined by W3C (http://www.w3.org/TR/access-control/).
|
Package cors provides a goa middleware that implements the Cross-Origin Resource Sharing (CORS) standard as defined by W3C (http://www.w3.org/TR/access-control/). |
|
Package jwt makes it possible to authorize API requests using JSON Web Tokens, see https://jwt.io/introduction/
|
Package jwt makes it possible to authorize API requests using JSON Web Tokens, see https://jwt.io/introduction/ |