server

Documentation

Index

• func PanicMiddleware(h http.Handler) http.Handler
• func TracingMiddleware(h http.Handler) http.Handler
• func WithTracingOpName(ctx context.Context, opName string) context.Context
• type Controller
• type MockController
  • func NewMockController(ctrl *gomock.Controller) *MockController
  • func (_m *MockController) EXPECT() *_MockControllerRecorder
  • func (_m *MockController) Health(ctx context.Context, i *models.HealthInput) error
• type Server
  • func New(c Controller, addr string) *Server
  • func NewWithMiddleware(c Controller, addr string, m []func(http.Handler) http.Handler) *Server
  • func (s *Server) Serve() error

Functions

func PanicMiddleware

func PanicMiddleware(h http.Handler) http.Handler

PanicMiddleware logs any panics. For now, we're continue throwing the panic up the stack so this may crash the process.

func TracingMiddleware

func TracingMiddleware(h http.Handler) http.Handler

Tracing creates a new span named after the URL path of the request. It places this span in the request context, for use by other handlers via opentracing.SpanFromContext() If a span exists in request headers, the span created by this middleware will be a child of that span.

func WithTracingOpName

func WithTracingOpName(ctx context.Context, opName string) context.Context

WithTracingOpName adds the op name to a context for use by the tracing library. It uses a pointer because it's called below in the stack and the only way to pass the info up is to have it a set a pointer. Even though it doesn't change the context we still have this return a context to maintain the illusion.

Types

type Controller

type Controller interface {

	// Health handles GET requests to /health
	//
	// 200: nil
	// 400: *models.BadRequest
	// 404: *models.NotFound
	// 500: *models.InternalError
	// default: client side HTTP errors, for example: context.DeadlineExceeded.
	Health(ctx context.Context, i *models.HealthInput) error
}

Controller defines the interface for the swagger-test service.

type MockController

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

Mock of Controller interface

func NewMockController

func NewMockController(ctrl *gomock.Controller) *MockController

func (*MockController) EXPECT

func (_m *MockController) EXPECT() *_MockControllerRecorder

func (*MockController) Health

func (_m *MockController) Health(ctx context.Context, i *models.HealthInput) error

type Server

type Server struct {
	// Handler should generally not be changed. It exposed to make testing easier.
	Handler http.Handler
	// contains filtered or unexported fields
}

Server defines a HTTP server that implements the Controller interface.

func New

func New(c Controller, addr string) *Server

New returns a Server that implements the Controller interface. It will start when "Serve" is called.

func NewWithMiddleware

func NewWithMiddleware(c Controller, addr string, m []func(http.Handler) http.Handler) *Server

NewWithMiddleware returns a Server that implemenets the Controller interface. It runs the middleware after the built-in middleware (e.g. logging), but before the controller methods. The middleware is executed in the order specified. The server will start when "Serve" is called.

func (*Server) Serve

func (s *Server) Serve() error

Serve starts the server. It will return if an error occurs.