mux

Documentation

Overview

Package mux provides support to bind domain level routes to the application mux.

Index

• func WebAPI(cfg Config, routeAdder RouteAdder, options ...func(opts *Options)) http.Handler
• func WithCORS(origins []string) func(opts *Options)
• type Config
• type Options
• type RouteAdder

Functions

func WebAPI

func WebAPI(cfg Config, routeAdder RouteAdder, options ...func(opts *Options)) http.Handler

WebAPI constructs a http.Handler with all application routes bound.

func WithCORS

func WithCORS(origins []string) func(opts *Options)

WithCORS provides configuration options for CORS.

Types

type Config

type Config struct {
	Build      string
	Log        *logger.Logger
	Auth       *auth.Auth
	AuthClient *authclient.Client
	DB         *sqlx.DB
	Tracer     trace.Tracer
}

Config contains all the mandatory systems required by handlers.

type Options

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

Options represent optional parameters.

type RouteAdder

type RouteAdder interface {
	Add(app *web.App, cfg Config)
}

RouteAdder defines behavior that sets the routes to bind for an instance of the service.