server

Documentation

Index

• func Error(ctx context.Context, writer http.ResponseWriter, err error)
• func NewRouter(h *Handler) *mux.Router
• func Respond(ctx context.Context, writer http.ResponseWriter, data interface{}, code int)
• func RespondError(ctx context.Context, writer http.ResponseWriter, err error, code int)
• func RespondHTML(writer http.ResponseWriter, title string, body string, code int)
• func Start()
• type Endpoint
• type Handler
  • func NewHandler() *Handler
  • func (h *Handler) Index(ctx context.Context, writer http.ResponseWriter, request *http.Request) error
• type HandlerFunc
  • func (fn HandlerFunc) ServeHTTP(writer http.ResponseWriter, request *http.Request)
• type ResponseError

Functions

func Error

func Error(ctx context.Context, writer http.ResponseWriter, err error)

Error handles all error responses for the API.

func NewRouter

func NewRouter(h *Handler) *mux.Router

NewRouter creates the routes to listen

func Respond

func Respond(ctx context.Context, writer http.ResponseWriter, data interface{}, code int)

Respond sends JSON response.

func RespondError

func RespondError(ctx context.Context, writer http.ResponseWriter, err error, code int)

RespondError sends JSON describing the error

func RespondHTML

func RespondHTML(writer http.ResponseWriter, title string, body string, code int)

RespondHTML sends HTML response.

func Start

func Start()

Start creates a server and starts listening

Types

type Endpoint

type Endpoint struct {
	Name        string
	Method      string
	Pattern     string
	HandlerFunc HandlerFunc
}

Endpoint defines an http endpoint to be queried from an external source

type Handler

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

Handler is the main struct to reference when calling the handling methods

func NewHandler

func NewHandler() *Handler

NewHandler generates a new handler

func (*Handler) Index

func (h *Handler) Index(ctx context.Context, writer http.ResponseWriter, request *http.Request) error

Index method to use as a heartbeat

type HandlerFunc

type HandlerFunc func(context.Context, http.ResponseWriter, *http.Request) error

HandlerFunc is a type that handles a http request

func (HandlerFunc) ServeHTTP

func (fn HandlerFunc) ServeHTTP(writer http.ResponseWriter, request *http.Request)

ServeHTTP needed in http.Handler implemented functions

type ResponseError

type ResponseError struct {
	Error string `json:"error"`
}

ResponseError is an error placeholder to be converted to JSON