Documentation
¶
Index ¶
Constants ¶
This section is empty.
Variables ¶
This section is empty.
Functions ¶
Types ¶
type GatewayConf ¶
type GatewayConf struct {
rest.RestConf
Upstreams []Upstream
Timeout time.Duration `json:",default=5s"`
}
GatewayConf is the configuration for gateway.
type RouteMapping ¶
type RouteMapping struct {
// Method is the HTTP method, like GET, POST, PUT, DELETE.
Method string
// Path is the HTTP path.
Path string
// RpcPath is the gRPC rpc method, with format of package.service/method
RpcPath string
}
RouteMapping is a mapping between a gateway route and an upstream rpc method.
type Server ¶
Server is a gateway server.
func MustNewServer ¶
func MustNewServer(c GatewayConf, opts ...Option) *Server
MustNewServer creates a new gateway server.
type Upstream ¶
type Upstream struct {
// Name is the name of the upstream.
Name string `json:",optional"`
// Grpc is the target of the upstream.
Grpc zrpc.RpcClientConf
// ProtoSets is the file list of proto set, like [hello.pb].
// if your proto file import another proto file, you need to write multi-file slice,
// like [hello.pb, common.pb].
ProtoSets []string `json:",optional"`
// Mappings is the mapping between gateway routes and Upstream rpc methods.
// Keep it blank if annotations are added in rpc methods.
Mappings []RouteMapping `json:",optional"`
}
Upstream is the configuration for an upstream.
Click to show internal directories.
Click to hide internal directories.