api

Documentation

Index

• func Encode(e *Endpoint) map[string]string
• func Validate(e *Endpoint) error
• func WithEndpoint(e *Endpoint) server.HandlerOption
• type API
• type Endpoint
  • func Decode(e map[string]string) *Endpoint
• type Event
• type FileDesc
  • func (*FileDesc) ProtoMessage()
  • func (m *FileDesc) Reset()
  • func (m *FileDesc) String() string
• type FileHeader
  • func (*FileHeader) ProtoMessage()
  • func (m *FileHeader) Reset()
  • func (m *FileHeader) String() string
• type Option
• type Options
• type Pair
• type Request
• type Response
• type Service
• type StreamType

Functions

func Encode

func Encode(e *Endpoint) map[string]string

Encode encodes an endpoint to endpoint metadata

func Validate

func Validate(e *Endpoint) error

Validate validates an endpoint to guarantee it won't blow up when being served

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 API

type API interface {
	// Init initialise options
	Init(...Option) error
	// Options Get the options
	Options() Options
	// Register a http handler
	Register(*Endpoint) error
	// Deregister unregister a route
	Deregister(*Endpoint) error
	// String implementation of api
	String() string
}

type Endpoint

type Endpoint struct {
	// RPC Method e.g. Greeter.Hello
	Name string `json:"name,omitempty"`
	// Description e.g what's this endpoint for
	Description string `json:"description,omitempty"`
	// API Handler e.g rpc, proxy
	Handler string `json:"handler,omitempty"`
	// HTTP Host e.g example.com
	Host []string `json:"host,omitempty"`
	// HTTP Methods e.g GET, POST
	Method []string `json:"method,omitempty"`
	// HTTP Path e.g /greeter. Expect POSIX regex
	Path []string `json:"path,omitempty"`
	// Body destination
	// "*" or "" - top level message value
	// "string" - inner message value
	Body string `json:"body,omitempty"`
	// Stream flag
	Stream StreamType `json:"stream,omitempty"`
}

Endpoint is a mapping between an RPC method and HTTP endpoint

func Decode

func Decode(e map[string]string) *Endpoint

Decode decodes endpoint metadata into an endpoint

type Event

type Event struct {
	// e.g login
	Name string `json:"name,omitempty"`
	// uuid
	Id string `json:"id,omitempty"`
	// unix timestamp of event
	Timestamp int64 `json:"timestamp,omitempty"`
	// event headers
	Header map[string]*Pair `json:"header,omitempty"`
	// the event data
	Data string `json:"data,omitempty"`
}

Event A HTTP event as RPC Forwarded by the event handler

type FileDesc

type FileDesc struct {
	// 文件名称
	Name string `protobuf:"bytes,1,opt,name=name,proto3" json:"name,omitempty"`
	// 读取偏离量
	Offset int64 `protobuf:"varint,2,opt,name=offset,proto3" json:"offset,omitempty"`
}

func (*FileDesc) ProtoMessage

func (*FileDesc) ProtoMessage()

func (*FileDesc) Reset

func (m *FileDesc) Reset()

func (*FileDesc) String

func (m *FileDesc) String() string

type FileHeader

type FileHeader struct {
	Name   string `protobuf:"bytes,1,opt,name=name,proto3" json:"name,omitempty"`
	Size   int64  `protobuf:"varint,2,opt,name=size,proto3" json:"size,omitempty"`
	Length int64  `protobuf:"varint,3,opt,name=length,proto3" json:"length,omitempty"`
	Chunk  []byte `protobuf:"bytes,4,opt,name=chunk,proto3" json:"chunk,omitempty"`
}

func (*FileHeader) ProtoMessage

func (*FileHeader) ProtoMessage()

func (*FileHeader) Reset

func (m *FileHeader) Reset()

func (*FileHeader) String

func (m *FileHeader) String() string

type Option

type Option func(*Options) error

type Options

type Options struct{}

type Pair

type Pair struct {
	Key    string   `json:"key,omitempty"`
	Values []string `json:"values,omitempty"`
}

type Request

type Request struct {
	Method string           `json:"method,omitempty"`
	Path   string           `json:"path,omitempty"`
	Header map[string]*Pair `json:"header,omitempty"`
	Get    map[string]*Pair `json:"get,omitempty"`
	Post   map[string]*Pair `json:"post,omitempty"`
	Body   string           `json:"body,omitempty"`
	Url    string           `json:"url,omitempty"`
}

Request A HTTP request as RPC Forward by the api handler

type Response

type Response struct {
	StatusCode int32            `json:"statusCode,omitempty"`
	Header     map[string]*Pair `json:"header,omitempty"`
	Body       string           `json:"body,omitempty"`
}

Response A HTTP response as RPC Expected response for the api handler

type Service

type Service struct {
	// Name of service
	Name string `json:"name,omitempty"`
	// The endpoint for this service
	Endpoint *Endpoint `json:"endpoint,omitempty"`
	// Versions of this service
	Services []*registry.Service `json:"services,omitempty"`
}

Service represents an API service

type StreamType

type StreamType string

const (
	Server        StreamType = "server"
	Client        StreamType = "client"
	Bidirectional StreamType = "bidirectional"
)