micro/api/router/router.go

33 lines
769 B
Go
Raw Normal View History

2019-06-03 18:44:43 +01:00
// Package router provides api service routing
package router
import (
"net/http"
"github.com/unistack-org/micro/v3/api"
2019-06-03 18:44:43 +01:00
)
var (
DefaultRouter Router
)
2019-06-03 18:44:43 +01:00
// Router is used to determine an endpoint for a request
type Router interface {
// Returns options
Options() Options
// Init initialize router
Init(...Option) error
2019-06-03 18:44:43 +01:00
// Stop the router
Close() error
// Endpoint returns an api.Service endpoint or an error if it does not exist
Endpoint(r *http.Request) (*api.Service, error)
// Register endpoint in router
Register(ep *api.Endpoint) error
// Deregister endpoint from router
Deregister(ep *api.Endpoint) error
2019-06-03 18:44:43 +01:00
// Route returns an api.Service route
Route(r *http.Request) (*api.Service, error)
// String representation of router
String() string
2019-06-03 18:44:43 +01:00
}