Documentation
¶
Overview ¶
Package openfgav1gateway is a reverse proxy.
It translates gRPC into RESTful JSON APIs.
Index ¶
- func RegisterOpenFGAServiceHandler(ctx context.Context, mux *runtime.ServeMux, conn *grpc.ClientConn) error
- func RegisterOpenFGAServiceHandlerClient(ctx context.Context, mux *runtime.ServeMux, ...) error
- func RegisterOpenFGAServiceHandlerFromEndpoint(ctx context.Context, mux *runtime.ServeMux, endpoint string, ...) (err error)
- func RegisterOpenFGAServiceHandlerServer(ctx context.Context, mux *runtime.ServeMux, ...) error
Constants ¶
This section is empty.
Variables ¶
This section is empty.
Functions ¶
func RegisterOpenFGAServiceHandler ¶
func RegisterOpenFGAServiceHandler(ctx context.Context, mux *runtime.ServeMux, conn *grpc.ClientConn) error
RegisterOpenFGAServiceHandler registers the http handlers for service OpenFGAService to "mux". The handlers forward requests to the grpc endpoint over "conn".
func RegisterOpenFGAServiceHandlerClient ¶
func RegisterOpenFGAServiceHandlerClient(ctx context.Context, mux *runtime.ServeMux, client openfgav1grpc.OpenFGAServiceClient) error
RegisterOpenFGAServiceHandlerClient registers the http handlers for service OpenFGAService to "mux". The handlers forward requests to the grpc endpoint over the given implementation of "openfgav1grpc.OpenFGAServiceClient". Note: the gRPC framework executes interceptors within the gRPC handler. If the passed in "openfgav1grpc.OpenFGAServiceClient" doesn't go through the normal gRPC flow (creating a gRPC client etc.) then it will be up to the passed in "openfgav1grpc.OpenFGAServiceClient" to call the correct interceptors. This client ignores the HTTP middlewares.
func RegisterOpenFGAServiceHandlerFromEndpoint ¶
func RegisterOpenFGAServiceHandlerFromEndpoint(ctx context.Context, mux *runtime.ServeMux, endpoint string, opts []grpc.DialOption) (err error)
RegisterOpenFGAServiceHandlerFromEndpoint is same as RegisterOpenFGAServiceHandler but automatically dials to "endpoint" and closes the connection when "ctx" gets done.
func RegisterOpenFGAServiceHandlerServer ¶
func RegisterOpenFGAServiceHandlerServer(ctx context.Context, mux *runtime.ServeMux, server openfgav1grpc.OpenFGAServiceServer) error
RegisterOpenFGAServiceHandlerServer registers the http handlers for service OpenFGAService to "mux". UnaryRPC :call OpenFGAServiceServer directly. StreamingRPC :currently unsupported pending https://github.com/grpc/grpc-go/issues/906. Note that using this registration option will cause many gRPC library features to stop working. Consider using RegisterOpenFGAServiceHandlerFromEndpoint instead. GRPC interceptors will not work for this type of registration. To use interceptors, you must use the "runtime.WithMiddlewares" option in the "runtime.NewServeMux" call.
Types ¶
This section is empty.
Source Files