api

package

v1.0.0 Latest Latest Go to latest Published: Aug 22, 2022 License: MIT Imports: 16 Imported by: 0

Details

Valid go.mod file

The Go module system was introduced in Go 1.11 and is the official dependency management solution for Go.
Redistributable license

Redistributable licenses place minimal restrictions on how software can be used, modified, and redistributed.
Tagged version

Modules with tagged versions give importers more predictable builds.
Stable version

When a project reaches major version v1 it is considered stable.
Learn more about best practices

This section is empty.

View Source

var Version string

Version receives its value at compile time

This section is empty.

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

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

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 (a *API) Mux() http.Handler

Mux returns the app routes

func (a *API) Serve() error

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

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

Wrap returns a HTTP handler wrapped by a middleware stack

Path	Synopsis
handler