api

package

v3.10.9 Latest Latest Go to latest Published: Mar 16, 2023 License: Apache-2.0 Imports: 20 Imported by: 4

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/micro-community/micro

Documentation ¶

Index ¶

func Encode(e *Endpoint) map[string]string
func RequestPayload(r *http.Request) ([]byte, error)
func Validate(e *Endpoint) error
func WithEndpoint(e *Endpoint) server.HandlerOption
type API
type Endpoint
- func Decode(e map[string]string) *Endpoint
type Option
type Options
type Server
type Service
type Wrapper

Constants ¶

This section is empty.

Variables ¶

This section is empty.

Functions ¶

func Encode ¶

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

Encode encodes an endpoint to endpoint metadata

func RequestPayload ¶

func RequestPayload(r *http.Request) ([]byte, error)

RequestPayload takes a *http.Request and returns the payload If the request is a GET the query string parameters are extracted and marshaled to JSON and the raw bytes are returned. If the request method is a POST the request body is read and returned

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 for api

Types ¶

type API ¶

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

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

func Decode ¶

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

Decode decodes endpoint metadata into an endpoint

type Option ¶

type Option func(*Options)

func ACMEHosts ¶

func ACMEHosts(hosts ...string) Option

func ACMEProvider ¶

func ACMEProvider(p acme.Provider) Option

func EnableACME ¶

func EnableACME(b bool) Option

func EnableCORS ¶

func EnableCORS(b bool) Option

func EnableTLS ¶

func EnableTLS(b bool) Option

func Resolver ¶

func Resolver(r resolver.Resolver) Option

func TLSConfig ¶

func TLSConfig(t *tls.Config) Option

func WrapHandler ¶

func WrapHandler(w ...Wrapper) Option

type Options ¶

type Options struct {
	EnableACME   bool
	EnableCORS   bool
	ACMEProvider acme.Provider
	EnableTLS    bool
	ACMEHosts    []string
	TLSConfig    *tls.Config
	Resolver     resolver.Resolver
	Wrappers     []Wrapper
}

type Server ¶

type Server interface {
	Address() string
	Init(opts ...Option) error
	Handle(path string, handler http.Handler)
	Start() error
	Stop() error
}

Server serves api requests

type Service ¶

type Service struct {
	// Name of service
	Name string
	// The endpoint for this service
	Endpoint *Endpoint
	// Versions of this service
	Services []*registry.Service
}

Service represents an API service

type Wrapper ¶

type Wrapper func(h http.Handler) http.Handler

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
auth
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
rpc Package rpc is a go-micro rpc handler.	Package rpc is a go-micro 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
subdomain Package subdomain is a resolver which uses the subdomain to determine the domain to route to.	Package subdomain is a resolver which uses the subdomain to determine the domain to route to.
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
server Package server is an API Gateway	Package server is an API Gateway
http Package http provides a http server with features; acme, cors, etc	Package http provides a http server with features; acme, cors, etc