Documentation ¶
Index ¶
Constants ¶
This section is empty.
Variables ¶
This section is empty.
Functions ¶
func WithEndpoint ¶
func WithEndpoint(e *Endpoint) server.HandlerOption
WithEndpoint returns a server.HandlerOption with endpoint metadata set
Usage:
proto.RegisterHandler(service.Server(), new(Handler), api.WithEndpoint( &api.Endpoint{ Name: "Greeter.Hello", Path: []string{"/greeter"}, }, ))
Types ¶
type Endpoint ¶
type Endpoint struct { // RPC Method e.g. Greeter.Hello Name string // Description e.g what's this endpoint for Description string // API Handler e.g rpc, proxy Handler string // HTTP Host e.g example.com Host []string // HTTP Methods e.g GET, POST Method []string // HTTP Path e.g /greeter. Expect POSIX regex Path []string // Body destination // "*" or "" - top level message value // "string" - inner message value Body string // Stream flag Stream bool }
Endpoint is a mapping between an RPC method and HTTP endpoint
Click to show internal directories.
Click to hide internal directories.