Documentation ¶
Overview ¶
Package api is a reverse proxy.
It translates gRPC into RESTful JSON APIs.
Index ¶
- func RegisterKuberpHandler(ctx context.Context, mux *runtime.ServeMux, conn *grpc.ClientConn) error
- func RegisterKuberpHandlerClient(ctx context.Context, mux *runtime.ServeMux, client KuberpClient) error
- func RegisterKuberpHandlerFromEndpoint(ctx context.Context, mux *runtime.ServeMux, endpoint string, ...) (err error)
- func RegisterKuberpServer(s *grpc.Server, srv KuberpServer)
- type EchoRequest
- func (*EchoRequest) Descriptor() ([]byte, []int)
- func (m *EchoRequest) GetMessage() string
- func (*EchoRequest) ProtoMessage()
- func (m *EchoRequest) Reset()
- func (m *EchoRequest) String() string
- func (m *EchoRequest) XXX_DiscardUnknown()
- func (m *EchoRequest) XXX_Marshal(b []byte, deterministic bool) ([]byte, error)
- func (dst *EchoRequest) XXX_Merge(src proto.Message)
- func (m *EchoRequest) XXX_Size() int
- func (m *EchoRequest) XXX_Unmarshal(b []byte) error
- type EchoResponse
- func (*EchoResponse) Descriptor() ([]byte, []int)
- func (m *EchoResponse) GetMessage() string
- func (*EchoResponse) ProtoMessage()
- func (m *EchoResponse) Reset()
- func (m *EchoResponse) String() string
- func (m *EchoResponse) XXX_DiscardUnknown()
- func (m *EchoResponse) XXX_Marshal(b []byte, deterministic bool) ([]byte, error)
- func (dst *EchoResponse) XXX_Merge(src proto.Message)
- func (m *EchoResponse) XXX_Size() int
- func (m *EchoResponse) XXX_Unmarshal(b []byte) error
- type KuberpClient
- type KuberpServer
- type ProxyRequest
- func (*ProxyRequest) Descriptor() ([]byte, []int)
- func (m *ProxyRequest) GetKind() string
- func (m *ProxyRequest) GetMessage() string
- func (m *ProxyRequest) GetName() string
- func (m *ProxyRequest) GetOrigin() string
- func (m *ProxyRequest) GetPath() string
- func (*ProxyRequest) ProtoMessage()
- func (m *ProxyRequest) Reset()
- func (m *ProxyRequest) String() string
- func (m *ProxyRequest) XXX_DiscardUnknown()
- func (m *ProxyRequest) XXX_Marshal(b []byte, deterministic bool) ([]byte, error)
- func (dst *ProxyRequest) XXX_Merge(src proto.Message)
- func (m *ProxyRequest) XXX_Size() int
- func (m *ProxyRequest) XXX_Unmarshal(b []byte) error
- type ProxyResponse
- func (*ProxyResponse) Descriptor() ([]byte, []int)
- func (m *ProxyResponse) GetMessage() string
- func (m *ProxyResponse) GetStatus() string
- func (*ProxyResponse) ProtoMessage()
- func (m *ProxyResponse) Reset()
- func (m *ProxyResponse) String() string
- func (m *ProxyResponse) XXX_DiscardUnknown()
- func (m *ProxyResponse) XXX_Marshal(b []byte, deterministic bool) ([]byte, error)
- func (dst *ProxyResponse) XXX_Merge(src proto.Message)
- func (m *ProxyResponse) XXX_Size() int
- func (m *ProxyResponse) XXX_Unmarshal(b []byte) error
Constants ¶
This section is empty.
Variables ¶
This section is empty.
Functions ¶
func RegisterKuberpHandler ¶
RegisterKuberpHandler registers the http handlers for service Kuberp to "mux". The handlers forward requests to the grpc endpoint over "conn".
func RegisterKuberpHandlerClient ¶
func RegisterKuberpHandlerClient(ctx context.Context, mux *runtime.ServeMux, client KuberpClient) error
RegisterKuberpHandlerClient registers the http handlers for service Kuberp to "mux". The handlers forward requests to the grpc endpoint over the given implementation of "KuberpClient". Note: the gRPC framework executes interceptors within the gRPC handler. If the passed in "KuberpClient" doesn't go through the normal gRPC flow (creating a gRPC client etc.) then it will be up to the passed in "KuberpClient" to call the correct interceptors.
func RegisterKuberpHandlerFromEndpoint ¶
func RegisterKuberpHandlerFromEndpoint(ctx context.Context, mux *runtime.ServeMux, endpoint string, opts []grpc.DialOption) (err error)
RegisterKuberpHandlerFromEndpoint is same as RegisterKuberpHandler but automatically dials to "endpoint" and closes the connection when "ctx" gets done.
func RegisterKuberpServer ¶
func RegisterKuberpServer(s *grpc.Server, srv KuberpServer)
Types ¶
type EchoRequest ¶
type EchoRequest struct { Message string `protobuf:"bytes,1,opt,name=message" json:"message,omitempty"` XXX_NoUnkeyedLiteral struct{} `json:"-"` XXX_unrecognized []byte `json:"-"` XXX_sizecache int32 `json:"-"` }
func (*EchoRequest) Descriptor ¶
func (*EchoRequest) Descriptor() ([]byte, []int)
func (*EchoRequest) GetMessage ¶
func (m *EchoRequest) GetMessage() string
func (*EchoRequest) ProtoMessage ¶
func (*EchoRequest) ProtoMessage()
func (*EchoRequest) Reset ¶
func (m *EchoRequest) Reset()
func (*EchoRequest) String ¶
func (m *EchoRequest) String() string
func (*EchoRequest) XXX_DiscardUnknown ¶
func (m *EchoRequest) XXX_DiscardUnknown()
func (*EchoRequest) XXX_Marshal ¶
func (m *EchoRequest) XXX_Marshal(b []byte, deterministic bool) ([]byte, error)
func (*EchoRequest) XXX_Merge ¶
func (dst *EchoRequest) XXX_Merge(src proto.Message)
func (*EchoRequest) XXX_Size ¶
func (m *EchoRequest) XXX_Size() int
func (*EchoRequest) XXX_Unmarshal ¶
func (m *EchoRequest) XXX_Unmarshal(b []byte) error
type EchoResponse ¶
type EchoResponse struct { Message string `protobuf:"bytes,1,opt,name=message" json:"message,omitempty"` XXX_NoUnkeyedLiteral struct{} `json:"-"` XXX_unrecognized []byte `json:"-"` XXX_sizecache int32 `json:"-"` }
func (*EchoResponse) Descriptor ¶
func (*EchoResponse) Descriptor() ([]byte, []int)
func (*EchoResponse) GetMessage ¶
func (m *EchoResponse) GetMessage() string
func (*EchoResponse) ProtoMessage ¶
func (*EchoResponse) ProtoMessage()
func (*EchoResponse) Reset ¶
func (m *EchoResponse) Reset()
func (*EchoResponse) String ¶
func (m *EchoResponse) String() string
func (*EchoResponse) XXX_DiscardUnknown ¶
func (m *EchoResponse) XXX_DiscardUnknown()
func (*EchoResponse) XXX_Marshal ¶
func (m *EchoResponse) XXX_Marshal(b []byte, deterministic bool) ([]byte, error)
func (*EchoResponse) XXX_Merge ¶
func (dst *EchoResponse) XXX_Merge(src proto.Message)
func (*EchoResponse) XXX_Size ¶
func (m *EchoResponse) XXX_Size() int
func (*EchoResponse) XXX_Unmarshal ¶
func (m *EchoResponse) XXX_Unmarshal(b []byte) error
type KuberpClient ¶
type KuberpClient interface { Echo(ctx context.Context, in *EchoRequest, opts ...grpc.CallOption) (*EchoResponse, error) Proxy(ctx context.Context, in *ProxyRequest, opts ...grpc.CallOption) (*ProxyResponse, error) }
func NewKuberpClient ¶
func NewKuberpClient(cc *grpc.ClientConn) KuberpClient
type KuberpServer ¶
type KuberpServer interface { Echo(context.Context, *EchoRequest) (*EchoResponse, error) Proxy(context.Context, *ProxyRequest) (*ProxyResponse, error) }
type ProxyRequest ¶
type ProxyRequest struct { Message string `protobuf:"bytes,1,opt,name=message" json:"message,omitempty"` Kind string `protobuf:"bytes,2,opt,name=kind" json:"kind,omitempty"` Name string `protobuf:"bytes,3,opt,name=name" json:"name,omitempty"` Path string `protobuf:"bytes,4,opt,name=path" json:"path,omitempty"` Origin string `protobuf:"bytes,5,opt,name=origin" json:"origin,omitempty"` XXX_NoUnkeyedLiteral struct{} `json:"-"` XXX_unrecognized []byte `json:"-"` XXX_sizecache int32 `json:"-"` }
func (*ProxyRequest) Descriptor ¶
func (*ProxyRequest) Descriptor() ([]byte, []int)
func (*ProxyRequest) GetKind ¶
func (m *ProxyRequest) GetKind() string
func (*ProxyRequest) GetMessage ¶
func (m *ProxyRequest) GetMessage() string
func (*ProxyRequest) GetName ¶
func (m *ProxyRequest) GetName() string
func (*ProxyRequest) GetOrigin ¶
func (m *ProxyRequest) GetOrigin() string
func (*ProxyRequest) GetPath ¶
func (m *ProxyRequest) GetPath() string
func (*ProxyRequest) ProtoMessage ¶
func (*ProxyRequest) ProtoMessage()
func (*ProxyRequest) Reset ¶
func (m *ProxyRequest) Reset()
func (*ProxyRequest) String ¶
func (m *ProxyRequest) String() string
func (*ProxyRequest) XXX_DiscardUnknown ¶
func (m *ProxyRequest) XXX_DiscardUnknown()
func (*ProxyRequest) XXX_Marshal ¶
func (m *ProxyRequest) XXX_Marshal(b []byte, deterministic bool) ([]byte, error)
func (*ProxyRequest) XXX_Merge ¶
func (dst *ProxyRequest) XXX_Merge(src proto.Message)
func (*ProxyRequest) XXX_Size ¶
func (m *ProxyRequest) XXX_Size() int
func (*ProxyRequest) XXX_Unmarshal ¶
func (m *ProxyRequest) XXX_Unmarshal(b []byte) error
type ProxyResponse ¶
type ProxyResponse struct { Message string `protobuf:"bytes,1,opt,name=message" json:"message,omitempty"` Status string `protobuf:"bytes,2,opt,name=status" json:"status,omitempty"` XXX_NoUnkeyedLiteral struct{} `json:"-"` XXX_unrecognized []byte `json:"-"` XXX_sizecache int32 `json:"-"` }
func (*ProxyResponse) Descriptor ¶
func (*ProxyResponse) Descriptor() ([]byte, []int)
func (*ProxyResponse) GetMessage ¶
func (m *ProxyResponse) GetMessage() string
func (*ProxyResponse) GetStatus ¶
func (m *ProxyResponse) GetStatus() string
func (*ProxyResponse) ProtoMessage ¶
func (*ProxyResponse) ProtoMessage()
func (*ProxyResponse) Reset ¶
func (m *ProxyResponse) Reset()
func (*ProxyResponse) String ¶
func (m *ProxyResponse) String() string
func (*ProxyResponse) XXX_DiscardUnknown ¶
func (m *ProxyResponse) XXX_DiscardUnknown()
func (*ProxyResponse) XXX_Marshal ¶
func (m *ProxyResponse) XXX_Marshal(b []byte, deterministic bool) ([]byte, error)
func (*ProxyResponse) XXX_Merge ¶
func (dst *ProxyResponse) XXX_Merge(src proto.Message)
func (*ProxyResponse) XXX_Size ¶
func (m *ProxyResponse) XXX_Size() int
func (*ProxyResponse) XXX_Unmarshal ¶
func (m *ProxyResponse) XXX_Unmarshal(b []byte) error