Package http implements the basic pace microservice handlers and a standard microservice server configured via environment variables.
- func ContextTransfer(ctx, targetCtx context.Context) context.Context
- func Environment() string
- func GetUserAgentFromContext(ctx context.Context) (string, error)
- func GetXForwardedForHeaderFromContext(ctx context.Context) (string, error)
- func JsonApiErrorWriterMiddleware(next http.Handler) http.Handler
- func RequestInContextMiddleware(next http.Handler) http.Handler
- func Router() *mux.Router
- func Server(handler http.Handler) *http.Server
All exported package errors.
func ContextTransfer ¶
ContextTransfer copies a request representation from one context to another.
func Environment ¶
func Environment() string
Environment returns the name of the current server environment
func GetUserAgentFromContext ¶
GetUserAgentFromContext returns the User-Agent header value from the request that is stored in the context. Returns ErrNotFound if the context does not have a request.
GetXForwardedForHeaderFromContext returns the X-Forwarded-For header value that would express that you forwarded the request that is stored in the context.
If the remote address of the request is 126.96.36.199:9999 then the value is that remote ip without the port. If the request already includes this header, the remote ip is appended to the value of that header. For example if the request on top of the remote ip also includes the header "X-Forwarded-For: 100.100.100.100" then the resulting value is "100.100.100.100, 188.8.131.52".
Returns ErrNotFound if the context does not have a request. Returns ErrInvalidRequest if the request in the context is malformed, for example because it does not have a remote address, which should never happen.
JsonApiErrorWriterMiddleware is a middleware that wraps http.ResponseWriter such that it forces responses with status codes 4xx/5xx to have Content-Type: application/vnd.api+json
RequestInContextMiddleware stores a representation of the request in the context of said request. Some information of that request can then be accessed through the context using functions of this package.
Router returns the default microservice endpoints for health, metrics and debugging