Documentation ¶
Overview ¶
Package api_v1 is a reverse proxy.
It translates gRPC into RESTful JSON APIs.
Index ¶
- func RegisterUsersHandler(ctx context.Context, mux *runtime.ServeMux, conn *grpc.ClientConn) error
- func RegisterUsersHandlerClient(ctx context.Context, mux *runtime.ServeMux, client UsersClient) error
- func RegisterUsersHandlerFromEndpoint(ctx context.Context, mux *runtime.ServeMux, endpoint string, ...) (err error)
- func RegisterUsersServer(s *grpc.Server, srv UsersServer)
- type CreateUserRequest
- func (*CreateUserRequest) Descriptor() ([]byte, []int)
- func (m *CreateUserRequest) GetName() string
- func (m *CreateUserRequest) GetRealName() string
- func (*CreateUserRequest) ProtoMessage()
- func (m *CreateUserRequest) Reset()
- func (m *CreateUserRequest) String() string
- func (m *CreateUserRequest) XXX_DiscardUnknown()
- func (m *CreateUserRequest) XXX_Marshal(b []byte, deterministic bool) ([]byte, error)
- func (dst *CreateUserRequest) XXX_Merge(src proto.Message)
- func (m *CreateUserRequest) XXX_Size() int
- func (m *CreateUserRequest) XXX_Unmarshal(b []byte) error
- type DeleteUserRequest
- func (*DeleteUserRequest) Descriptor() ([]byte, []int)
- func (m *DeleteUserRequest) GetId() string
- func (*DeleteUserRequest) ProtoMessage()
- func (m *DeleteUserRequest) Reset()
- func (m *DeleteUserRequest) String() string
- func (m *DeleteUserRequest) XXX_DiscardUnknown()
- func (m *DeleteUserRequest) XXX_Marshal(b []byte, deterministic bool) ([]byte, error)
- func (dst *DeleteUserRequest) XXX_Merge(src proto.Message)
- func (m *DeleteUserRequest) XXX_Size() int
- func (m *DeleteUserRequest) XXX_Unmarshal(b []byte) error
- type DeleteUserResponse
- func (*DeleteUserResponse) Descriptor() ([]byte, []int)
- func (*DeleteUserResponse) ProtoMessage()
- func (m *DeleteUserResponse) Reset()
- func (m *DeleteUserResponse) String() string
- func (m *DeleteUserResponse) XXX_DiscardUnknown()
- func (m *DeleteUserResponse) XXX_Marshal(b []byte, deterministic bool) ([]byte, error)
- func (dst *DeleteUserResponse) XXX_Merge(src proto.Message)
- func (m *DeleteUserResponse) XXX_Size() int
- func (m *DeleteUserResponse) XXX_Unmarshal(b []byte) error
- type GetUserRequest
- func (*GetUserRequest) Descriptor() ([]byte, []int)
- func (m *GetUserRequest) GetId() string
- func (*GetUserRequest) ProtoMessage()
- func (m *GetUserRequest) Reset()
- func (m *GetUserRequest) String() string
- func (m *GetUserRequest) XXX_DiscardUnknown()
- func (m *GetUserRequest) XXX_Marshal(b []byte, deterministic bool) ([]byte, error)
- func (dst *GetUserRequest) XXX_Merge(src proto.Message)
- func (m *GetUserRequest) XXX_Size() int
- func (m *GetUserRequest) XXX_Unmarshal(b []byte) error
- type ListUsersRequest
- func (*ListUsersRequest) Descriptor() ([]byte, []int)
- func (*ListUsersRequest) ProtoMessage()
- func (m *ListUsersRequest) Reset()
- func (m *ListUsersRequest) String() string
- func (m *ListUsersRequest) XXX_DiscardUnknown()
- func (m *ListUsersRequest) XXX_Marshal(b []byte, deterministic bool) ([]byte, error)
- func (dst *ListUsersRequest) XXX_Merge(src proto.Message)
- func (m *ListUsersRequest) XXX_Size() int
- func (m *ListUsersRequest) XXX_Unmarshal(b []byte) error
- type ListUsersResponse
- func (*ListUsersResponse) Descriptor() ([]byte, []int)
- func (m *ListUsersResponse) GetUsers() []*User
- func (*ListUsersResponse) ProtoMessage()
- func (m *ListUsersResponse) Reset()
- func (m *ListUsersResponse) String() string
- func (m *ListUsersResponse) XXX_DiscardUnknown()
- func (m *ListUsersResponse) XXX_Marshal(b []byte, deterministic bool) ([]byte, error)
- func (dst *ListUsersResponse) XXX_Merge(src proto.Message)
- func (m *ListUsersResponse) XXX_Size() int
- func (m *ListUsersResponse) XXX_Unmarshal(b []byte) error
- type UpdateUserRequest
- func (*UpdateUserRequest) Descriptor() ([]byte, []int)
- func (m *UpdateUserRequest) GetId() string
- func (m *UpdateUserRequest) GetName() string
- func (*UpdateUserRequest) ProtoMessage()
- func (m *UpdateUserRequest) Reset()
- func (m *UpdateUserRequest) String() string
- func (m *UpdateUserRequest) XXX_DiscardUnknown()
- func (m *UpdateUserRequest) XXX_Marshal(b []byte, deterministic bool) ([]byte, error)
- func (dst *UpdateUserRequest) XXX_Merge(src proto.Message)
- func (m *UpdateUserRequest) XXX_Size() int
- func (m *UpdateUserRequest) XXX_Unmarshal(b []byte) error
- type UpdateUserResponse
- func (*UpdateUserResponse) Descriptor() ([]byte, []int)
- func (*UpdateUserResponse) ProtoMessage()
- func (m *UpdateUserResponse) Reset()
- func (m *UpdateUserResponse) String() string
- func (m *UpdateUserResponse) XXX_DiscardUnknown()
- func (m *UpdateUserResponse) XXX_Marshal(b []byte, deterministic bool) ([]byte, error)
- func (dst *UpdateUserResponse) XXX_Merge(src proto.Message)
- func (m *UpdateUserResponse) XXX_Size() int
- func (m *UpdateUserResponse) XXX_Unmarshal(b []byte) error
- type User
- func (*User) Descriptor() ([]byte, []int)
- func (m *User) GetId() string
- func (m *User) GetName() string
- func (m *User) GetRealName() string
- func (*User) ProtoMessage()
- func (m *User) Reset()
- func (m *User) String() string
- func (m *User) XXX_DiscardUnknown()
- func (m *User) XXX_Marshal(b []byte, deterministic bool) ([]byte, error)
- func (dst *User) XXX_Merge(src proto.Message)
- func (m *User) XXX_Size() int
- func (m *User) XXX_Unmarshal(b []byte) error
- type UsersClient
- type UsersServer
Constants ¶
This section is empty.
Variables ¶
This section is empty.
Functions ¶
func RegisterUsersHandler ¶
RegisterUsersHandler registers the http handlers for service Users to "mux". The handlers forward requests to the grpc endpoint over "conn".
func RegisterUsersHandlerClient ¶
func RegisterUsersHandlerClient(ctx context.Context, mux *runtime.ServeMux, client UsersClient) error
RegisterUsersHandlerClient registers the http handlers for service Users to "mux". The handlers forward requests to the grpc endpoint over the given implementation of "UsersClient". Note: the gRPC framework executes interceptors within the gRPC handler. If the passed in "UsersClient" doesn't go through the normal gRPC flow (creating a gRPC client etc.) then it will be up to the passed in "UsersClient" to call the correct interceptors.
func RegisterUsersHandlerFromEndpoint ¶
func RegisterUsersHandlerFromEndpoint(ctx context.Context, mux *runtime.ServeMux, endpoint string, opts []grpc.DialOption) (err error)
RegisterUsersHandlerFromEndpoint is same as RegisterUsersHandler but automatically dials to "endpoint" and closes the connection when "ctx" gets done.
func RegisterUsersServer ¶
func RegisterUsersServer(s *grpc.Server, srv UsersServer)
Types ¶
type CreateUserRequest ¶
type CreateUserRequest struct { Name string `protobuf:"bytes,1,opt,name=name,proto3" json:"name,omitempty"` RealName string `protobuf:"bytes,2,opt,name=real_name,json=realName,proto3" json:"real_name,omitempty"` XXX_NoUnkeyedLiteral struct{} `json:"-"` XXX_unrecognized []byte `json:"-"` XXX_sizecache int32 `json:"-"` }
func (*CreateUserRequest) Descriptor ¶
func (*CreateUserRequest) Descriptor() ([]byte, []int)
func (*CreateUserRequest) GetName ¶
func (m *CreateUserRequest) GetName() string
func (*CreateUserRequest) GetRealName ¶
func (m *CreateUserRequest) GetRealName() string
func (*CreateUserRequest) ProtoMessage ¶
func (*CreateUserRequest) ProtoMessage()
func (*CreateUserRequest) Reset ¶
func (m *CreateUserRequest) Reset()
func (*CreateUserRequest) String ¶
func (m *CreateUserRequest) String() string
func (*CreateUserRequest) XXX_DiscardUnknown ¶
func (m *CreateUserRequest) XXX_DiscardUnknown()
func (*CreateUserRequest) XXX_Marshal ¶
func (m *CreateUserRequest) XXX_Marshal(b []byte, deterministic bool) ([]byte, error)
func (*CreateUserRequest) XXX_Merge ¶
func (dst *CreateUserRequest) XXX_Merge(src proto.Message)
func (*CreateUserRequest) XXX_Size ¶
func (m *CreateUserRequest) XXX_Size() int
func (*CreateUserRequest) XXX_Unmarshal ¶
func (m *CreateUserRequest) XXX_Unmarshal(b []byte) error
type DeleteUserRequest ¶
type DeleteUserRequest struct { Id string `protobuf:"bytes,1,opt,name=id,proto3" json:"id,omitempty"` XXX_NoUnkeyedLiteral struct{} `json:"-"` XXX_unrecognized []byte `json:"-"` XXX_sizecache int32 `json:"-"` }
func (*DeleteUserRequest) Descriptor ¶
func (*DeleteUserRequest) Descriptor() ([]byte, []int)
func (*DeleteUserRequest) GetId ¶
func (m *DeleteUserRequest) GetId() string
func (*DeleteUserRequest) ProtoMessage ¶
func (*DeleteUserRequest) ProtoMessage()
func (*DeleteUserRequest) Reset ¶
func (m *DeleteUserRequest) Reset()
func (*DeleteUserRequest) String ¶
func (m *DeleteUserRequest) String() string
func (*DeleteUserRequest) XXX_DiscardUnknown ¶
func (m *DeleteUserRequest) XXX_DiscardUnknown()
func (*DeleteUserRequest) XXX_Marshal ¶
func (m *DeleteUserRequest) XXX_Marshal(b []byte, deterministic bool) ([]byte, error)
func (*DeleteUserRequest) XXX_Merge ¶
func (dst *DeleteUserRequest) XXX_Merge(src proto.Message)
func (*DeleteUserRequest) XXX_Size ¶
func (m *DeleteUserRequest) XXX_Size() int
func (*DeleteUserRequest) XXX_Unmarshal ¶
func (m *DeleteUserRequest) XXX_Unmarshal(b []byte) error
type DeleteUserResponse ¶
type DeleteUserResponse struct { XXX_NoUnkeyedLiteral struct{} `json:"-"` XXX_unrecognized []byte `json:"-"` XXX_sizecache int32 `json:"-"` }
func (*DeleteUserResponse) Descriptor ¶
func (*DeleteUserResponse) Descriptor() ([]byte, []int)
func (*DeleteUserResponse) ProtoMessage ¶
func (*DeleteUserResponse) ProtoMessage()
func (*DeleteUserResponse) Reset ¶
func (m *DeleteUserResponse) Reset()
func (*DeleteUserResponse) String ¶
func (m *DeleteUserResponse) String() string
func (*DeleteUserResponse) XXX_DiscardUnknown ¶
func (m *DeleteUserResponse) XXX_DiscardUnknown()
func (*DeleteUserResponse) XXX_Marshal ¶
func (m *DeleteUserResponse) XXX_Marshal(b []byte, deterministic bool) ([]byte, error)
func (*DeleteUserResponse) XXX_Merge ¶
func (dst *DeleteUserResponse) XXX_Merge(src proto.Message)
func (*DeleteUserResponse) XXX_Size ¶
func (m *DeleteUserResponse) XXX_Size() int
func (*DeleteUserResponse) XXX_Unmarshal ¶
func (m *DeleteUserResponse) XXX_Unmarshal(b []byte) error
type GetUserRequest ¶
type GetUserRequest struct { Id string `protobuf:"bytes,1,opt,name=id,proto3" json:"id,omitempty"` XXX_NoUnkeyedLiteral struct{} `json:"-"` XXX_unrecognized []byte `json:"-"` XXX_sizecache int32 `json:"-"` }
func (*GetUserRequest) Descriptor ¶
func (*GetUserRequest) Descriptor() ([]byte, []int)
func (*GetUserRequest) GetId ¶
func (m *GetUserRequest) GetId() string
func (*GetUserRequest) ProtoMessage ¶
func (*GetUserRequest) ProtoMessage()
func (*GetUserRequest) Reset ¶
func (m *GetUserRequest) Reset()
func (*GetUserRequest) String ¶
func (m *GetUserRequest) String() string
func (*GetUserRequest) XXX_DiscardUnknown ¶
func (m *GetUserRequest) XXX_DiscardUnknown()
func (*GetUserRequest) XXX_Marshal ¶
func (m *GetUserRequest) XXX_Marshal(b []byte, deterministic bool) ([]byte, error)
func (*GetUserRequest) XXX_Merge ¶
func (dst *GetUserRequest) XXX_Merge(src proto.Message)
func (*GetUserRequest) XXX_Size ¶
func (m *GetUserRequest) XXX_Size() int
func (*GetUserRequest) XXX_Unmarshal ¶
func (m *GetUserRequest) XXX_Unmarshal(b []byte) error
type ListUsersRequest ¶
type ListUsersRequest struct { XXX_NoUnkeyedLiteral struct{} `json:"-"` XXX_unrecognized []byte `json:"-"` XXX_sizecache int32 `json:"-"` }
func (*ListUsersRequest) Descriptor ¶
func (*ListUsersRequest) Descriptor() ([]byte, []int)
func (*ListUsersRequest) ProtoMessage ¶
func (*ListUsersRequest) ProtoMessage()
func (*ListUsersRequest) Reset ¶
func (m *ListUsersRequest) Reset()
func (*ListUsersRequest) String ¶
func (m *ListUsersRequest) String() string
func (*ListUsersRequest) XXX_DiscardUnknown ¶
func (m *ListUsersRequest) XXX_DiscardUnknown()
func (*ListUsersRequest) XXX_Marshal ¶
func (m *ListUsersRequest) XXX_Marshal(b []byte, deterministic bool) ([]byte, error)
func (*ListUsersRequest) XXX_Merge ¶
func (dst *ListUsersRequest) XXX_Merge(src proto.Message)
func (*ListUsersRequest) XXX_Size ¶
func (m *ListUsersRequest) XXX_Size() int
func (*ListUsersRequest) XXX_Unmarshal ¶
func (m *ListUsersRequest) XXX_Unmarshal(b []byte) error
type ListUsersResponse ¶
type ListUsersResponse struct { Users []*User `protobuf:"bytes,1,rep,name=users,proto3" json:"users,omitempty"` XXX_NoUnkeyedLiteral struct{} `json:"-"` XXX_unrecognized []byte `json:"-"` XXX_sizecache int32 `json:"-"` }
func (*ListUsersResponse) Descriptor ¶
func (*ListUsersResponse) Descriptor() ([]byte, []int)
func (*ListUsersResponse) GetUsers ¶
func (m *ListUsersResponse) GetUsers() []*User
func (*ListUsersResponse) ProtoMessage ¶
func (*ListUsersResponse) ProtoMessage()
func (*ListUsersResponse) Reset ¶
func (m *ListUsersResponse) Reset()
func (*ListUsersResponse) String ¶
func (m *ListUsersResponse) String() string
func (*ListUsersResponse) XXX_DiscardUnknown ¶
func (m *ListUsersResponse) XXX_DiscardUnknown()
func (*ListUsersResponse) XXX_Marshal ¶
func (m *ListUsersResponse) XXX_Marshal(b []byte, deterministic bool) ([]byte, error)
func (*ListUsersResponse) XXX_Merge ¶
func (dst *ListUsersResponse) XXX_Merge(src proto.Message)
func (*ListUsersResponse) XXX_Size ¶
func (m *ListUsersResponse) XXX_Size() int
func (*ListUsersResponse) XXX_Unmarshal ¶
func (m *ListUsersResponse) XXX_Unmarshal(b []byte) error
type UpdateUserRequest ¶
type UpdateUserRequest struct { Id string `protobuf:"bytes,1,opt,name=id,proto3" json:"id,omitempty"` Name string `protobuf:"bytes,2,opt,name=name,proto3" json:"name,omitempty"` XXX_NoUnkeyedLiteral struct{} `json:"-"` XXX_unrecognized []byte `json:"-"` XXX_sizecache int32 `json:"-"` }
func (*UpdateUserRequest) Descriptor ¶
func (*UpdateUserRequest) Descriptor() ([]byte, []int)
func (*UpdateUserRequest) GetId ¶
func (m *UpdateUserRequest) GetId() string
func (*UpdateUserRequest) GetName ¶
func (m *UpdateUserRequest) GetName() string
func (*UpdateUserRequest) ProtoMessage ¶
func (*UpdateUserRequest) ProtoMessage()
func (*UpdateUserRequest) Reset ¶
func (m *UpdateUserRequest) Reset()
func (*UpdateUserRequest) String ¶
func (m *UpdateUserRequest) String() string
func (*UpdateUserRequest) XXX_DiscardUnknown ¶
func (m *UpdateUserRequest) XXX_DiscardUnknown()
func (*UpdateUserRequest) XXX_Marshal ¶
func (m *UpdateUserRequest) XXX_Marshal(b []byte, deterministic bool) ([]byte, error)
func (*UpdateUserRequest) XXX_Merge ¶
func (dst *UpdateUserRequest) XXX_Merge(src proto.Message)
func (*UpdateUserRequest) XXX_Size ¶
func (m *UpdateUserRequest) XXX_Size() int
func (*UpdateUserRequest) XXX_Unmarshal ¶
func (m *UpdateUserRequest) XXX_Unmarshal(b []byte) error
type UpdateUserResponse ¶
type UpdateUserResponse struct { XXX_NoUnkeyedLiteral struct{} `json:"-"` XXX_unrecognized []byte `json:"-"` XXX_sizecache int32 `json:"-"` }
func (*UpdateUserResponse) Descriptor ¶
func (*UpdateUserResponse) Descriptor() ([]byte, []int)
func (*UpdateUserResponse) ProtoMessage ¶
func (*UpdateUserResponse) ProtoMessage()
func (*UpdateUserResponse) Reset ¶
func (m *UpdateUserResponse) Reset()
func (*UpdateUserResponse) String ¶
func (m *UpdateUserResponse) String() string
func (*UpdateUserResponse) XXX_DiscardUnknown ¶
func (m *UpdateUserResponse) XXX_DiscardUnknown()
func (*UpdateUserResponse) XXX_Marshal ¶
func (m *UpdateUserResponse) XXX_Marshal(b []byte, deterministic bool) ([]byte, error)
func (*UpdateUserResponse) XXX_Merge ¶
func (dst *UpdateUserResponse) XXX_Merge(src proto.Message)
func (*UpdateUserResponse) XXX_Size ¶
func (m *UpdateUserResponse) XXX_Size() int
func (*UpdateUserResponse) XXX_Unmarshal ¶
func (m *UpdateUserResponse) XXX_Unmarshal(b []byte) error
type User ¶
type User struct { Id string `protobuf:"bytes,1,opt,name=id,proto3" json:"id,omitempty"` Name string `protobuf:"bytes,2,opt,name=name,proto3" json:"name,omitempty"` RealName string `protobuf:"bytes,3,opt,name=real_name,json=realName,proto3" json:"real_name,omitempty"` XXX_NoUnkeyedLiteral struct{} `json:"-"` XXX_unrecognized []byte `json:"-"` XXX_sizecache int32 `json:"-"` }
func (*User) Descriptor ¶
func (*User) GetRealName ¶
func (*User) ProtoMessage ¶
func (*User) ProtoMessage()
func (*User) XXX_DiscardUnknown ¶
func (m *User) XXX_DiscardUnknown()
func (*User) XXX_Unmarshal ¶
type UsersClient ¶
type UsersClient interface { ListUsers(ctx context.Context, in *ListUsersRequest, opts ...grpc.CallOption) (*ListUsersResponse, error) GetUser(ctx context.Context, in *GetUserRequest, opts ...grpc.CallOption) (*User, error) CreateUser(ctx context.Context, in *CreateUserRequest, opts ...grpc.CallOption) (*User, error) UpdateUser(ctx context.Context, in *UpdateUserRequest, opts ...grpc.CallOption) (*UpdateUserResponse, error) DeleteUser(ctx context.Context, in *DeleteUserRequest, opts ...grpc.CallOption) (*empty.Empty, error) }
UsersClient is the client API for Users service.
For semantics around ctx use and closing/ending streaming RPCs, please refer to https://godoc.org/google.golang.org/grpc#ClientConn.NewStream.
func NewUsersClient ¶
func NewUsersClient(cc *grpc.ClientConn) UsersClient
type UsersServer ¶
type UsersServer interface { ListUsers(context.Context, *ListUsersRequest) (*ListUsersResponse, error) GetUser(context.Context, *GetUserRequest) (*User, error) CreateUser(context.Context, *CreateUserRequest) (*User, error) UpdateUser(context.Context, *UpdateUserRequest) (*UpdateUserResponse, error) DeleteUser(context.Context, *DeleteUserRequest) (*empty.Empty, error) }
UsersServer is the server API for Users service.