go-micro/web/web.go

// Package web provides web based micro services
package web

import (
	"context"
	"net/http"
	"time"

	"github.com/google/uuid"
)

// Service is a web service with service discovery built in.
type Service interface {
	Client() *http.Client
	Init(opts ...Option) error
	Options() Options
	Handle(pattern string, handler http.Handler)
	HandleFunc(pattern string, handler func(http.ResponseWriter, *http.Request))
	Start() error
	Stop() error
	Run() error
}

// Option for web.
type Option func(o *Options)

// Web basic Defaults.
var (
	// For serving.
	DefaultName    = "go-web"
	DefaultVersion = "latest"
	DefaultId      = uuid.New().String()
	DefaultAddress = ":0"

	// for registration.
	DefaultRegisterTTL      = time.Second * 90
	DefaultRegisterInterval = time.Second * 30

	// static directory.
	DefaultStaticDir     = "html"
	DefaultRegisterCheck = func(context.Context) error { return nil }
)

// NewService returns a new web.Service.
func NewService(opts ...Option) Service {
	return newService(opts...)
}