api

Documentation

Index

• Variables
• type API
  • func New(e env.Bag, logger zerolog.Logger, smtpClient smtp.Client, ...) *API
  • func (a *API) Mux() http.Handler
  • func (a *API) Serve() error
  • func (a *API) Wrap(fn http.Handler) http.Handler

Variables

var Version string

Version receives its value at compile time

Types

type API

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

API is the app entry point: it contains the HTTP server, config and services

func New

func New(
	e env.Bag,
	logger zerolog.Logger,
	smtpClient smtp.Client,
	converterProvider converter.Provider,
) *API

New returns a new http server for the API

func (*API) Mux

func (a *API) Mux() http.Handler

Mux returns the app routes

func (*API) Serve

func (a *API) Serve() error

Serve listens and serves for incoming HTTP request. It also handles graceful shutdown logic

func (*API) Wrap

func (a *API) Wrap(fn http.Handler) http.Handler

Wrap returns a HTTP handler wrapped by a middleware stack