httpserver

Documentation

Overview

Package httpserver provides a simple HTTP server that serves the API.

Index

• type GRPCHTTPHandlerRegister
• type HTTPServer
  • func NewHTTPServer(ctx context.Context, opts ...Opt) *HTTPServer
  • func (s *HTTPServer) Serve() error
• type Opt
  • func WithClient(conn *grpc.ClientConn) Opt
  • func WithLogger(logger *zap.Logger) Opt
  • func WithRegisters(registers ...GRPCHTTPHandlerRegister) Opt
  • func WithServer(server *http.Server) Opt

Types

type GRPCHTTPHandlerRegister

type GRPCHTTPHandlerRegister func(context.Context, *runtime.ServeMux, *grpc.ClientConn) error

GRPCHTTPHandlerRegister is a function that registers the grpc-gateway handlers

type HTTPServer

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

HTTPServer is the http server implementation

func NewHTTPServer

func NewHTTPServer(ctx context.Context, opts ...Opt) *HTTPServer

NewHTTPServer creates a new HTTPServer

func (*HTTPServer) Serve

func (s *HTTPServer) Serve() error

Serve starts the http server

type Opt

type Opt func(*HTTPServer)

Opt is a functional option for HttpServer

func WithClient

func WithClient(conn *grpc.ClientConn) Opt

WithClient sets the grpc client for the HTTPServer

func WithLogger

func WithLogger(logger *zap.Logger) Opt

WithLogger sets the logger for the HTTPServer

func WithRegisters

func WithRegisters(registers ...GRPCHTTPHandlerRegister) Opt

WithRegisters sets the http handlers for the HTTPServer

func WithServer

func WithServer(server *http.Server) Opt

WithServer sets the http server for the HTTPServer