Documentation ¶
Overview ¶
Package http provides a general purpose HTTP binding for endpoints.
Index ¶
- Constants
- func DefaultDecodeJson[Request interface{}](ctx *fh.RequestCtx) (request Request, err error)
- func DefaultErrorEncoder(ctx *fh.RequestCtx, err error)
- func EncodeJSONResponse[Response interface{}](ctx *fh.RequestCtx, response Response) error
- func NewClient[I, O interface{}](method string, url URI, enc EncodeRequestFunc[I], dec DecodeResponseFunc[O], ...) *client[I, O]
- func NewServer[I, O interface{}](e endpoint.Endpoint[O], dec DecodeRequestFunc[I], enc EncodeResponseFunc[O], ...) fh.RequestHandler
- func NopRequestDecoder(ctx *fh.RequestCtx) (interface{}, error)
- func PopulateRequestContext(ctx *fh.RequestCtx)
- type ClientOption
- type ClientResponseFunc
- type CreateRequestFunc
- type DecodeRequestFunc
- type DecodeResponseFunc
- type EncodeRequestFunc
- type EncodeResponseFunc
- type ErrorEncoder
- type FastClient
- type Headerer
- type RequestFunc
- type ServerFinalizerFunc
- type ServerOption
- func ServerAfter[I, O interface{}](after ...ServerResponseFunc) ServerOption[I, O]
- func ServerBefore[I, O interface{}](before ...RequestFunc) ServerOption[I, O]
- func ServerErrorEncoder[I, O interface{}](ee ErrorEncoder) ServerOption[I, O]
- func ServerErrorHandler[I, O interface{}](errorHandler transport.ErrorHandler) ServerOption[I, O]
- func ServerErrorLogger[I, O interface{}](logger log.Logger) ServerOption[I, O]
- func ServerFinalizer[I, O interface{}](f ...ServerFinalizerFunc) ServerOption[I, O]
- type ServerResponseFunc
- type StatusCoder
- type URI
Examples ¶
Constants ¶
const ( // ContextKeyRequestMethod is populated in the context by // PopulateRequestContext. Its value is r.Method. ContextKeyRequestMethod contextKey = iota // ContextKeyRequestURI is populated in the context by // PopulateRequestContext. Its value is r.RequestURI. ContextKeyRequestURI // ContextKeyRequestPath is populated in the context by // PopulateRequestContext. Its value is r.URL.Path. ContextKeyRequestPath // ContextKeyRequestProto is populated in the context by // PopulateRequestContext. Its value is r.Proto. ContextKeyRequestProto // ContextKeyRequestHost is populated in the context by // PopulateRequestContext. Its value is r.Host. ContextKeyRequestHost // ContextKeyRequestRemoteAddr is populated in the context by // PopulateRequestContext. Its value is r.RemoteAddr. ContextKeyRequestRemoteAddr // ContextKeyRequestXForwardedFor is populated in the context by // PopulateRequestContext. Its value is r.Header.Get("X-Forwarded-For"). ContextKeyRequestXForwardedFor // ContextKeyRequestXForwardedProto is populated in the context by // PopulateRequestContext. Its value is r.Header.Get("X-Forwarded-Proto"). ContextKeyRequestXForwardedProto // ContextKeyRequestAuthorization is populated in the context by // PopulateRequestContext. Its value is r.Header.Get("Authorization"). ContextKeyRequestAuthorization // ContextKeyRequestReferer is populated in the context by // PopulateRequestContext. Its value is r.Header.Get("Referer"). ContextKeyRequestReferer // ContextKeyRequestUserAgent is populated in the context by // PopulateRequestContext. Its value is r.Header.Get("User-Agent"). ContextKeyRequestUserAgent // ContextKeyRequestXRequestID is populated in the context by // PopulateRequestContext. Its value is r.Header.Get("X-Request-Id"). ContextKeyRequestXRequestID // ContextKeyRequestAccept is populated in the context by // PopulateRequestContext. Its value is r.Header.Get("Accept"). ContextKeyRequestAccept // ContextKeyResponseHeaders is populated in the context whenever a // ServerFinalizerFunc is specified. Its value is of type http.Header, and // is captured only once the entire response has been written. ContextKeyResponseHeaders // ContextKeyResponseSize is populated in the context whenever a // ServerFinalizerFunc is specified. Its value is of type int64. ContextKeyResponseSize )
Variables ¶
This section is empty.
Functions ¶
func DefaultDecodeJson ¶
func DefaultDecodeJson[Request interface{}](ctx *fh.RequestCtx) (request Request, err error)
func DefaultErrorEncoder ¶
func DefaultErrorEncoder(ctx *fh.RequestCtx, err error)
DefaultErrorEncoder writes the error to the ResponseWriter, by default a content type of text/plain, a body of the plain text of the error, and a status code of 500. If the error implements Headerer, the provided headers will be applied to the response. If the error implements json.Marshaler, and the marshaling succeeds, a content type of application/json and the JSON encoded form of the error will be used. If the error implements StatusCoder, the provided StatusCode will be used instead of 500.
func EncodeJSONResponse ¶
func EncodeJSONResponse[Response interface{}](ctx *fh.RequestCtx, response Response) error
EncodeJSONResponse is a EncodeResponseFunc that serializes the response as a JSON object to the ResponseWriter. Many JSON-over-HTTP services can use it as a sensible default. If the response implements Headerer, the provided headers will be applied to the response. If the response implements StatusCoder, the provided StatusCode will be used instead of 200.
func NewClient ¶
func NewClient[I, O interface{}](method string, url URI, enc EncodeRequestFunc[I], dec DecodeResponseFunc[O], options ...ClientOption[I, O]) *client[I, O]
NewClient constructs a usable Client for a single remote method.
func NewServer ¶
func NewServer[I, O interface{}]( e endpoint.Endpoint[O], dec DecodeRequestFunc[I], enc EncodeResponseFunc[O], options ...ServerOption[I, O], ) fh.RequestHandler
NewServer constructs a new server, which implements http.Handler and wraps the provided endpoint.
func NopRequestDecoder ¶
func NopRequestDecoder(ctx *fh.RequestCtx) (interface{}, error)
NopRequestDecoder is a DecodeRequestFunc that can be used for requests that do not need to be decoded, and simply returns nil, nil.
func PopulateRequestContext ¶
func PopulateRequestContext(ctx *fh.RequestCtx)
PopulateRequestContext is a RequestFunc that populates several values into the context from the HTTP request. Those values may be extracted using the corresponding ContextKey type in this package.
Example ¶
handler := NewServer( func(ctx context.Context, request interface{}) (response interface{}, err error) { fmt.Println("Method", ctx.Value(ContextKeyRequestMethod).(string)) fmt.Println("RequestPath", ctx.Value(ContextKeyRequestPath).(string)) fmt.Println("RequestURI", ctx.Value(ContextKeyRequestURI).(string)) fmt.Println("X-Request-ID", ctx.Value(ContextKeyRequestXRequestID).(string)) return struct{}{}, nil }, func(_ *fh.RequestCtx) (interface{}, error) { return struct{}{}, nil }, func(*fh.RequestCtx, interface{}) error { return nil }, ServerBefore[interface{}, interface{}](PopulateRequestContext), ) req, err := http.NewRequest("PATCH", fmt.Sprintf("%s/search?q=sympatico", "http://test/"), nil) if err != nil { panic(err) } req.Header.Set("X-Request-Id", "a1b2c3d4e5") res, err := fasthttptest.FastServerHandler(handler, req) if err != nil { fmt.Println(res) panic(err) }
Output: Method PATCH RequestPath /search RequestURI http://test/search?q=sympatico X-Request-ID a1b2c3d4e5
Types ¶
type ClientOption ¶
type ClientOption[I, O interface{}] func(*client[I, O])
ClientOption sets an optional parameter for clients.
func BufferedStream ¶
func BufferedStream[I, O interface{}](buffered bool) ClientOption[I, O]
BufferedStream sets whether the HTTP response body is left open, allowing it to be read from later. Useful for transporting a file as a buffered stream. That body has to be drained and closed to properly end the request.
type ClientResponseFunc ¶
type ClientResponseFunc func(*fh.RequestCtx) *fh.RequestCtx
ClientResponseFunc may take information from an HTTP request and make the response available for consumption. ClientResponseFuncs are only executed in clients, after a request has been made, but prior to it being decoded.
type CreateRequestFunc ¶
CreateRequestFunc creates an outgoing HTTP request based on the passed request object. It's designed to be used in HTTP clients, for client-side endpoints. It's a more powerful version of EncodeRequestFunc, and can be used if more fine-grained control of the HTTP request is required.
type DecodeRequestFunc ¶
type DecodeRequestFunc[Request interface{}] func(*fh.RequestCtx) (request Request, err error)
DecodeRequestFunc extracts a user-domain request object from an HTTP request object. It's designed to be used in HTTP servers, for server-side endpoints. One straightforward DecodeRequestFunc could be something that JSON decodes from the request body to the concrete request type.
type DecodeResponseFunc ¶
DecodeResponseFunc extracts a user-domain response object from an HTTP response object. It's designed to be used in HTTP clients, for client-side endpoints. One straightforward DecodeResponseFunc could be something that JSON decodes from the response body to the concrete response type.
type EncodeRequestFunc ¶
EncodeRequestFunc encodes the passed request object into the HTTP request object. It's designed to be used in HTTP clients, for client-side endpoints. One straightforward EncodeRequestFunc could be something that JSON encodes the object directly to the request body.
type EncodeResponseFunc ¶
type EncodeResponseFunc[Response interface{}] func(*fh.RequestCtx, Response) error
EncodeResponseFunc encodes the passed response object to the HTTP response writer. It's designed to be used in HTTP servers, for server-side endpoints. One straightforward EncodeResponseFunc could be something that JSON encodes the object directly to the response body.
type ErrorEncoder ¶
type ErrorEncoder func(ctx *fh.RequestCtx, err error)
ErrorEncoder is responsible for encoding an error to the ResponseWriter. Users are encouraged to use custom ErrorEncoders to encode HTTP errors to their clients, and will likely want to pass and check for their own error types. See the example shipping/handling service.
type FastClient ¶
FastClient is an interface that models *http.Client.
type Headerer ¶
Headerer is checked by DefaultErrorEncoder. If an error value implements Headerer, the provided headers will be applied to the response writer, after the Content-Type is set.
type RequestFunc ¶
type RequestFunc func(*fh.RequestCtx)
RequestFunc may take information from an HTTP request and put it into a request context. In Servers, RequestFuncs are executed prior to invoking the endpoint. In Clients, RequestFuncs are executed after creating the request but prior to invoking the HTTP client.
func SetRequestHeader ¶
func SetRequestHeader(key, val string) RequestFunc
SetRequestHeader returns a RequestFunc that sets the given header.
type ServerFinalizerFunc ¶
type ServerFinalizerFunc func(ctx *fh.RequestCtx)
ServerFinalizerFunc can be used to perform work at the end of an HTTP request, after the response has been written to the client. The principal intended use is for request logging. In addition to the response code provided in the function signature, additional response parameters are provided in the context under keys with the ContextKeyResponse prefix.
type ServerOption ¶
type ServerOption[I, O interface{}] func(*server[I, O])
ServerOption sets an optional parameter for servers.
func ServerAfter ¶
func ServerAfter[I, O interface{}](after ...ServerResponseFunc) ServerOption[I, O]
ServerAfter functions are executed on the HTTP response writer after the endpoint is invoked, but before anything is written to the client.
func ServerBefore ¶
func ServerBefore[I, O interface{}](before ...RequestFunc) ServerOption[I, O]
ServerBefore functions are executed on the HTTP request object before the request is decoded.
func ServerErrorEncoder ¶
func ServerErrorEncoder[I, O interface{}](ee ErrorEncoder) ServerOption[I, O]
ServerErrorEncoder is used to encode errors to the http.ResponseWriter whenever they're encountered in the processing of a request. Clients can use this to provide custom error formatting and response codes. By default, errors will be written with the DefaultErrorEncoder.
func ServerErrorHandler ¶
func ServerErrorHandler[I, O interface{}](errorHandler transport.ErrorHandler) ServerOption[I, O]
ServerErrorHandler is used to handle non-terminal errors. By default, non-terminal errors are ignored. This is intended as a diagnostic measure. Finer-grained control of error handling, including logging in more detail, should be performed in a custom ServerErrorEncoder or ServerFinalizer, both of which have access to the context.
func ServerErrorLogger ¶
func ServerErrorLogger[I, O interface{}](logger log.Logger) ServerOption[I, O]
ServerErrorLogger is used to log non-terminal errors. By default, no errors are logged. This is intended as a diagnostic measure. Finer-grained control of error handling, including logging in more detail, should be performed in a custom ServerErrorEncoder or ServerFinalizer, both of which have access to the context. Deprecated: Use ServerErrorHandler instead.
func ServerFinalizer ¶
func ServerFinalizer[I, O interface{}](f ...ServerFinalizerFunc) ServerOption[I, O]
ServerFinalizer is executed at the end of every HTTP request. By default, no finalizer is registered.
type ServerResponseFunc ¶
type ServerResponseFunc func(*fh.RequestCtx)
ServerResponseFunc may take information from a request context and use it to manipulate a ResponseWriter. ServerResponseFuncs are only executed in servers, after invoking the endpoint but prior to writing a response.
func SetContentType ¶
func SetContentType(contentType string) ServerResponseFunc
SetContentType returns a ServerResponseFunc that sets the Content-Type header to the provided value.
func SetResponseHeader ¶
func SetResponseHeader(key, val string) ServerResponseFunc
SetResponseHeader returns a ServerResponseFunc that sets the given header.
type StatusCoder ¶
type StatusCoder interface {
StatusCode() int
}
StatusCoder is checked by DefaultErrorEncoder. If an error value implements StatusCoder, the StatusCode will be used when encoding the error. By default, StatusInternalServerError (500) is used.