api

package

v0.17.5 Latest Latest Go to latest Published: May 28, 2021 License: MIT Imports: 5 Imported by: 0

Details

Valid go.mod file

The Go module system was introduced in Go 1.11 and is the official dependency management solution for Go.
Redistributable license

Redistributable licenses place minimal restrictions on how software can be used, modified, and redistributed.
Tagged version

Modules with tagged versions give importers more predictable builds.
Stable version

When a project reaches major version v1 it is considered stable.
Learn more about best practices

Repository

github.com/lack-io/vine

Documentation ¶

Index ¶

func Decode(e map[string]string) *apipb.Endpoint
func Encode(e *apipb.Endpoint) map[string]string
func Validate(e *apipb.Endpoint) error
func WithEndpoint(e *apipb.Endpoint) server.HandlerOption
type Api
type Option
type Options

Constants ¶

This section is empty.

Variables ¶

This section is empty.

Functions ¶

func Decode ¶

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

Decode decodes endpoint metadata into an endpoint

func Encode ¶

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

Encode encodes an endpoint to endpoint metadata

func Validate ¶

func Validate(e *apipb.Endpoint) error

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

func WithEndpoint ¶

func WithEndpoint(e *apipb.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(*apipb.Endpoint) error
	// Deregister unregister a route
	Deregister(*apipb.Endpoint) error
	// String implementation of api
	String() string
}

type Option ¶

type Option func(*Options) error

type Options ¶

type Options struct{}

Source Files ¶

View all Source files

api.go

Directories ¶

?	: This menu
/	: Search site
f or F	: Jump to
y or Y	: Canonical URL

Path	Synopsis
handler Package handler provides http handlers	Package handler provides http handlers
api Package api provides an http-rpc handler which provides the entire http request over rpc	Package api provides an http-rpc handler which provides the entire http request over rpc
event Package event provides a handler which publishes an event	Package event provides a handler which publishes an event
http Package http is a http reverse proxy handler	Package http is a http reverse proxy handler
openapi
openapi/statik
rpc Package rpc is a vine rpc handler.	Package rpc is a vine rpc handler.
web Package web contains the web handler including websocket support	Package web contains the web handler including websocket support
resolver Package resolver resolves a http request to an endpoint	Package resolver resolves a http request to an endpoint
grpc Package grpc resolves a grpc service like /greeter.Say/Hello to greeter service	Package grpc resolves a grpc service like /greeter.Say/Hello to greeter service
host Package host resolves using http host	Package host resolves using http host
path Package path resolves using http path	Package path resolves using http path
vpath Package vpath resolves using http path and recognised versioned urls	Package vpath resolves using http path and recognised versioned urls
router Package router provides api service routing	Package router provides api service routing
registry Package registry provides a dynamic api service router	Package registry provides a dynamic api service router
static
util
server Package server provides an API gateway server which handles inbound requests	Package server provides an API gateway server which handles inbound requests
cors
http Package http provides a http server with features; acme, cors, etc	Package http provides a http server with features; acme, cors, etc