mux

package

v0.0.0-...-4887a92 Latest Latest Go to latest Published: Apr 26, 2024 License: Apache-2.0 Imports: 10 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

Repository

github.com/ardanlabs/service

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 BusDomain
type Config
type Options
type RouteAdder

Constants ¶

This section is empty.

Variables ¶

This section is empty.

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 BusDomain ¶

type BusDomain struct {
	Delegate *delegate.Delegate
	User     *userbus.Core
}

BusDomain represents the set of core business packages.

type Config ¶

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

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.

Source Files ¶

View all Source files

mux.go

?	: This menu
/	: Search site
f or F	: Jump to
y or Y	: Canonical URL