bricks: github.com/pace/bricks/http Index | Files | Directories

package http

import "github.com/pace/bricks/http"

Package http implements the basic pace microservice handlers and a standard microservice server configured via environment variables.

Index

Package Files

context.go doc.go errors.go metrics.go middleware.go router.go server.go

Variables

var (
    ErrNotFound       = errors.New("not found")
    ErrInvalidRequest = errors.New("request is invalid")
)

All exported package errors.

func ContextTransfer Uses

func ContextTransfer(ctx, targetCtx context.Context) context.Context

ContextTransfer copies a request representation from one context to another.

func Environment Uses

func Environment() string

Environment returns the name of the current server environment

func GetUserAgentFromContext Uses

func GetUserAgentFromContext(ctx context.Context) (string, error)

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.

func GetXForwardedForHeaderFromContext Uses

func GetXForwardedForHeaderFromContext(ctx context.Context) (string, error)

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 12.34.56.78: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, 12.34.56.78".

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.

func JsonApiErrorWriterMiddleware Uses

func JsonApiErrorWriterMiddleware(next http.Handler) http.Handler

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

func RequestInContextMiddleware Uses

func RequestInContextMiddleware(next http.Handler) http.Handler

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.

func Router Uses

func Router() *mux.Router

Router returns the default microservice endpoints for health, metrics and debugging

func Server Uses

func Server(handler http.Handler) *http.Server

Server returns a http.Server configured using environment variables, following https://12factor.net/.

Directories

PathSynopsis
jsonapiPackage jsonapi provides a serializer and deserializer for jsonapi.org spec payloads.
jsonapi/generatorPackage generator translates an OpenAPIv3 specification into working go code that handles marshalling, error handling, parameter parsing and validation.
jsonapi/runtimePackage runtime contains functions for marshalling, error handling, parameter parsing and validation.
longpoll
oauth2Package oauth2 provides a middelware that introspects the auth token on behalf of PACE services and populate the request context with useful information when the token is valid, otherwise aborts the request.
oauth2/middleware
oidc
security
security/apikey
transport

Package http imports 21 packages (graph). Updated 2020-12-01. Refresh now. Tools for package owners.