gateway

Documentation

Overview

Package gateway implements an HTTP server that forwards JSON requests to an upstream SpiceDB gRPC server.

Index

• func OtelAnnotator(ctx context.Context, r *http.Request) metadata.MD
• type CloserHandler
  • func NewHandler(ctx context.Context, upstreamAddr, upstreamTLSCertPath string) (*CloserHandler, error)
  • func (cdh CloserHandler) Close() error
  • func (cdh CloserHandler) ServeHTTP(writer http.ResponseWriter, request *http.Request)
• type HandlerRegisterer

Functions

func OtelAnnotator

func OtelAnnotator(ctx context.Context, r *http.Request) metadata.MD

OtelAnnotator propagates the OpenTelemetry tracing context to the outgoing gRPC metadata.

Types

type CloserHandler

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

CloserHandler is a http.Handler and a io.Closer. Meant to keep track of resources to closer for a handler.

func NewHandler

func NewHandler(ctx context.Context, upstreamAddr, upstreamTLSCertPath string) (*CloserHandler, error)

NewHandler creates an REST gateway HTTP CloserHandler with the provided upstream configuration.

func (CloserHandler) Close

func (cdh CloserHandler) Close() error

func (CloserHandler) ServeHTTP

func (cdh CloserHandler) ServeHTTP(writer http.ResponseWriter, request *http.Request)

type HandlerRegisterer

type HandlerRegisterer func(ctx context.Context, mux *runtime.ServeMux, conn *grpc.ClientConn) error

HandlerRegisterer is a function that registers a Gateway Handler in a ServeMux