apiv1gateway

Documentation

Overview

Package apiv1gateway is a reverse proxy.

It translates gRPC into RESTful JSON APIs.

Deprecated: This package has moved to "buf.build/gen/go/authzed/api/grpc-ecosystem/gateway/v2/authzed/api/v1/apiv1gateway". Use that import path instead.

Index

• Variables

Variables

var (

	// RegisterPermissionsServiceHandlerServer registers the http handlers for service PermissionsService to "mux".
	// UnaryRPC     :call PermissionsServiceServer 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 RegisterPermissionsServiceHandlerFromEndpoint 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.
	RegisterPermissionsServiceHandlerServer = gateway.RegisterPermissionsServiceHandlerServer

	// RegisterPermissionsServiceHandlerFromEndpoint is same as RegisterPermissionsServiceHandler but
	// automatically dials to "endpoint" and closes the connection when "ctx" gets done.
	RegisterPermissionsServiceHandlerFromEndpoint = gateway.RegisterPermissionsServiceHandlerFromEndpoint

	// RegisterPermissionsServiceHandler registers the http handlers for service PermissionsService to "mux".
	// The handlers forward requests to the grpc endpoint over "conn".
	RegisterPermissionsServiceHandler = gateway.RegisterPermissionsServiceHandler

	// RegisterPermissionsServiceHandlerClient registers the http handlers for service PermissionsService
	// to "mux". The handlers forward requests to the grpc endpoint over the given implementation of "apiv1grpc.PermissionsServiceClient".
	// Note: the gRPC framework executes interceptors within the gRPC handler. If the passed in "apiv1grpc.PermissionsServiceClient"
	// doesn't go through the normal gRPC flow (creating a gRPC client etc.) then it will be up to the passed in
	// "apiv1grpc.PermissionsServiceClient" to call the correct interceptors. This client ignores the HTTP middlewares.
	RegisterPermissionsServiceHandlerClient = gateway.RegisterPermissionsServiceHandlerClient
)