restproxyserver

Documentation

Index

• Constants
• func DefaultHTTPErrorHandler(ctx context.Context, mux *ServeMux, marshaler Marshaler, w http.ResponseWriter, ...)
• type DialOption
• type ErrorHandlerFunc
• type HandleChainFunc
• type HeaderMatcherFunc
• type Logger
• type Marshaler
• type QueryParameterParser
• type RESTProxyServer
  • func New(log Logger, name string, port string, opts ...RESTProxyServerOption) RESTProxyServer
  • func (g *RESTProxyServer) Listen() error
  • func (g *RESTProxyServer) Shutdown(ctx context.Context) error
  • func (g *RESTProxyServer) String() string
• type RESTProxyServerOption
  • func SetQueryParameterParser(p QueryParameterParser) RESTProxyServerOption
  • func WithAppendedDialOption(d DialOption) RESTProxyServerOption
  • func WithErrorHandler(o ErrorHandlerFunc) RESTProxyServerOption
  • func WithGRPCAddress(a string) RESTProxyServerOption
  • func WithHTTPHandler(h HandleChainFunc) RESTProxyServerOption
  • func WithHandlePath(verb string, urlPath string, ...) RESTProxyServerOption
  • func WithIncomingHeaderMatcher(o HeaderMatcherFunc) RESTProxyServerOption
  • func WithMarshaler(mime string, m Marshaler) RESTProxyServerOption
  • func WithOutgoingHeaderMatcher(o HeaderMatcherFunc) RESTProxyServerOption
  • func WithPrependedDialOption(d DialOption) RESTProxyServerOption
  • func WithRegisterHandler(r RegisterRESTProxyServer) RESTProxyServerOption
• type RegisterRESTProxyServer
• type ServeMux

Constants

const (
	MIMEWildcard = runtime.MIMEWildcard
)

Functions

func DefaultHTTPErrorHandler

func DefaultHTTPErrorHandler(ctx context.Context, mux *ServeMux, marshaler Marshaler, w http.ResponseWriter, r *http.Request, err error)

Types

type DialOption

type DialOption = grpc.DialOption

type ErrorHandlerFunc

type ErrorHandlerFunc = runtime.ErrorHandlerFunc

type HandleChainFunc

type HandleChainFunc = httpserver.HandleChainFunc

type HeaderMatcherFunc

type HeaderMatcherFunc = runtime.HeaderMatcherFunc

type Logger

type Logger = logger.Logger

type Marshaler

type Marshaler = runtime.Marshaler

type QueryParameterParser

type QueryParameterParser = runtime.QueryParameterParser

type RESTProxyServer

type RESTProxyServer struct {
	// contains filtered or unexported fields
}

RESTProxyServer represents the grpc-gateway rest openapiv2 serve endpoint.

func New

func New(log Logger, name string, port string, opts ...RESTProxyServerOption) RESTProxyServer

New creates a new RESTProxyServer that is bound to a specific GRPC Gateway API. This object complies with the standard Listener interface and can be managed by the startup.Listeners object.

func (*RESTProxyServer) Listen

func (g *RESTProxyServer) Listen() error

func (*RESTProxyServer) Shutdown

func (g *RESTProxyServer) Shutdown(ctx context.Context) error

func (*RESTProxyServer) String

func (g *RESTProxyServer) String() string

type RESTProxyServerOption

type RESTProxyServerOption func(*RESTProxyServer)

func SetQueryParameterParser

func SetQueryParameterParser(p QueryParameterParser) RESTProxyServerOption

SetQueryParameterParser adds an intercepror that matches header values.

func WithAppendedDialOption

func WithAppendedDialOption(d DialOption) RESTProxyServerOption

WithAppendedDialOption appends a grpc dial option.

func WithErrorHandler

func WithErrorHandler(o ErrorHandlerFunc) RESTProxyServerOption

WithErrorHandler adds error handling in special cases - e.g on 402 or 429.

func WithGRPCAddress

func WithGRPCAddress(a string) RESTProxyServerOption

WithGRPCAddress - overides the defaultGRPSAddress ('localhost:<port>')

func WithHTTPHandler

func WithHTTPHandler(h HandleChainFunc) RESTProxyServerOption

WithHTTPHandler adds a handler on the http endpoint.

func WithHandlePath

func WithHandlePath(verb string, urlPath string, f func(http.ResponseWriter, *http.Request, map[string]string)) RESTProxyServerOption

WithHandlePath add REST file path handler.

func WithIncomingHeaderMatcher

func WithIncomingHeaderMatcher(o HeaderMatcherFunc) RESTProxyServerOption

WithOutgoingHeaderMatcher matches header values on oupput. WithIncomingHeaderMatcher adds an intercepror that matches header values.

func WithMarshaler

func WithMarshaler(mime string, m Marshaler) RESTProxyServerOption

WithMarshaler specifies on an optional marshaler.

func WithOutgoingHeaderMatcher

func WithOutgoingHeaderMatcher(o HeaderMatcherFunc) RESTProxyServerOption

WithOutgoingHeaderMatcher matches header values on oupput.

func WithPrependedDialOption

func WithPrependedDialOption(d DialOption) RESTProxyServerOption

WithPrependedDialOption prepends a grpc dial option.

func WithRegisterHandler

func WithRegisterHandler(r RegisterRESTProxyServer) RESTProxyServerOption

WithRegisterHandler adds another grpc-gateway handler

type RegisterRESTProxyServer

type RegisterRESTProxyServer func(context.Context, *ServeMux, string, []DialOption) error

type ServeMux

type ServeMux = runtime.ServeMux