http

README

HTTP Server

The HTTP Server is a go-micro.Server. It's a partial implementation which strips out codecs, transports, etc but enables you to create a HTTP Server that could potentially be used for REST based API services.

Usage

import (
	"net/http"

	"github.com/unistack-org/micro/v3/server"
	httpServer "github.com/unistack-org/micro-server-http"
)

func main() {
	srv := httpServer.NewServer(
		server.Name("helloworld"),
	)

	mux := http.NewServeMux()
	mux.HandleFunc("/", func(w http.ResponseWriter, r *http.Request) {
		w.Write([]byte(`hello world`))
	})

	hd := srv.NewHandler(mux)

	srv.Handle(hd)
	srv.Start()
	srv.Register()
}

Or as part of a service

import (
	"net/http"

	"github.com/unistack-org/micro/v3"
	"github.com/unistack-org/micro/v3/server"
	httpServer "github.com/unistack-org/micro-server-http"
)

func main() {
	srv := httpServer.NewServer(
		server.Name("helloworld"),
	)

	mux := http.NewServeMux()
	mux.HandleFunc("/", func(w http.ResponseWriter, r *http.Request) {
		w.Write([]byte(`hello world`))
	})

	hd := srv.NewHandler(mux)

	srv.Handle(hd)

	service := micro.NewService(
		micro.Server(srv),
	)
	service.Init()
	service.Run()
}

Documentation

Overview

Package http implements a go-micro.Server

Index

• Variables
• func ErrorHandler(fn errorHandler) server.Option
• func FillRequest(ctx context.Context, req interface{}, opts ...FillRequestOption) error
• func GetError(err interface{}) interface{}
• func GetRspCode(ctx context.Context) int
• func HTTPServer(hs *http.Server) server.Option
• func HandlerEndpoints(md []EndpointMetadata) server.HandlerOption
• func Middleware(mw ...func(http.Handler) http.Handler) server.Option
• func PathHandler(method, path string, handler http.HandlerFunc) server.Option
• func RegisterCORSHandler(b bool) server.HandlerOption
• func RegisterRPCHandler(b bool) server.Option
• func SetError(err interface{}) error
• func SetRspCode(ctx context.Context, code int)
• func SetRspHeader(ctx context.Context, h http.Header)
• type EndpointMetadata
• type Error
  • func (err *Error) Error() string
• type FillRequestOption
  • func Cookie(cookies ...string) FillRequestOption
  • func Header(headers ...string) FillRequestOption
• type Server
  • func NewServer(opts ...server.Option) *Server
  • func (h *Server) Deregister() error
  • func (h *Server) HTTPHandlerFunc(handler interface{}) (http.HandlerFunc, error)
  • func (h *Server) Handle(handler server.Handler) error
  • func (h *Server) Health() bool
  • func (h *Server) Init(opts ...server.Option) error
  • func (h *Server) Live() bool
  • func (h *Server) Name() string
  • func (h *Server) NewHandler(handler interface{}, opts ...server.HandlerOption) server.Handler
  • func (h *Server) NewSubscriber(topic string, handler interface{}, opts ...server.SubscriberOption) server.Subscriber
  • func (h *Server) Options() server.Options
  • func (h *Server) Ready() bool
  • func (h *Server) Register() error
  • func (h *Server) ServeHTTP(w http.ResponseWriter, r *http.Request)
  • func (h *Server) Start() error
  • func (h *Server) Stop() error
  • func (h *Server) String() string
  • func (h *Server) Subscribe(sb server.Subscriber) error

Variables

var (
	DefaultErrorHandler = func(ctx context.Context, s server.Handler, w http.ResponseWriter, r *http.Request, err error, status int) {
		w.WriteHeader(status)
		if _, cerr := w.Write([]byte(err.Error())); cerr != nil {
			logger.DefaultLogger.Error(ctx, "write error", cerr)
		}
	}
	DefaultContentType = "application/json"
)

Functions

func ErrorHandler

func ErrorHandler(fn errorHandler) server.Option

ErrorHandler specifies handler for errors

func FillRequest

func FillRequest(ctx context.Context, req interface{}, opts ...FillRequestOption) error

func GetError

func GetError(err interface{}) interface{}

GetError return underline error

func GetRspCode

func GetRspCode(ctx context.Context) int

GetRspCode used internally by generated http server handler

func HTTPServer

func HTTPServer(hs *http.Server) server.Option

HTTPServer provide ability to pass *http.Server

func HandlerEndpoints

func HandlerEndpoints(md []EndpointMetadata) server.HandlerOption

func Middleware

func Middleware(mw ...func(http.Handler) http.Handler) server.Option

Middleware passes http middlewares

func PathHandler

func PathHandler(method, path string, handler http.HandlerFunc) server.Option

PathHandler specifies http handler for path regexp

func RegisterCORSHandler

func RegisterCORSHandler(b bool) server.HandlerOption

RegisterCORSHandler registers cors endpoints with /ServiceName.ServiceEndpoint method POPTIONSOST

func RegisterRPCHandler

func RegisterRPCHandler(b bool) server.Option

RegisterRPCHandler registers compatibility endpoints with /ServiceName.ServiceEndpoint method POST

func SetError

func SetError(err interface{}) error

SetError pass error to caller

func SetRspCode

func SetRspCode(ctx context.Context, code int)

SetRspCode saves response code in context, must be used by handler to specify http code

func SetRspHeader

func SetRspHeader(ctx context.Context, h http.Header)

SetRspHeader add response headers

Types

type EndpointMetadata

type EndpointMetadata struct {
	Name   string
	Path   string
	Method string
	Body   string
	Stream bool
}

type Error

type Error struct {
	// contains filtered or unexported fields
}

Error struct holds error

func (*Error) Error

func (err *Error) Error() string

Error func for error interface

type FillRequestOption

type FillRequestOption func(*handlerOptions)

func Cookie

func Cookie(cookies ...string) FillRequestOption

func Header

func Header(headers ...string) FillRequestOption

type Server

type Server struct {
	sync.RWMutex
	// contains filtered or unexported fields
}

func NewServer

func NewServer(opts ...server.Option) *Server

func (*Server) Deregister

func (h *Server) Deregister() error

func (*Server) HTTPHandlerFunc

func (h *Server) HTTPHandlerFunc(handler interface{}) (http.HandlerFunc, error)

func (*Server) Handle

func (h *Server) Handle(handler server.Handler) error

func (*Server) Health

func (h *Server) Health() bool

func (*Server) Init

func (h *Server) Init(opts ...server.Option) error

func (*Server) Live

func (h *Server) Live() bool

func (*Server) Name

func (h *Server) Name() string

func (*Server) NewHandler

func (h *Server) NewHandler(handler interface{}, opts ...server.HandlerOption) server.Handler

func (*Server) NewSubscriber

func (h *Server) NewSubscriber(topic string, handler interface{}, opts ...server.SubscriberOption) server.Subscriber

func (*Server) Options

func (h *Server) Options() server.Options

func (*Server) Ready

func (h *Server) Ready() bool

func (*Server) Register

func (h *Server) Register() error

func (*Server) ServeHTTP

func (h *Server) ServeHTTP(w http.ResponseWriter, r *http.Request)

func (*Server) Start

func (h *Server) Start() error

func (*Server) Stop

func (h *Server) Stop() error

func (*Server) String

func (h *Server) String() string

func (*Server) Subscribe

func (h *Server) Subscribe(sb server.Subscriber) error