handlers

package

v0.0.0-...-c46be8d Latest Latest Go to latest Published: Nov 15, 2021 License: Apache-2.0 Imports: 13 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/lgarciaaco/machina-api

Links

Open Source Insights

Documentation ¶

Overview ¶

Package handlers manages the different versions of the API.

Index ¶

func APIMux(cfg APIMuxConfig, options ...func(opts *Options)) http.Handler
func DebugMux(build string, log *zap.SugaredLogger, db *sqlx.DB) http.Handler
func DebugStandardLibraryMux() *http.ServeMux
func WithCORS(origin string) func(opts *Options)
type APIMuxConfig
type Options

Constants ¶

This section is empty.

Variables ¶

This section is empty.

Functions ¶

func APIMux ¶

func APIMux(cfg APIMuxConfig, options ...func(opts *Options)) http.Handler

APIMux constructs an http.Handler with all application routes defined.

func DebugMux ¶

func DebugMux(build string, log *zap.SugaredLogger, db *sqlx.DB) http.Handler

DebugMux registers all the debug standard library routes and then custom debug application routes for the service. This bypassing the use of the DefaultServerMux. Using the DefaultServerMux would be a security risk since a dependency could inject a handler into our service without us knowing it.

func DebugStandardLibraryMux ¶

func DebugStandardLibraryMux() *http.ServeMux

DebugStandardLibraryMux registers all the debug routes from the standard library into a new mux bypassing the use of the DefaultServerMux. Using the DefaultServerMux would be a security risk since a dependency could inject a handler into our service without us knowing it.

func WithCORS ¶

func WithCORS(origin string) func(opts *Options)

WithCORS provides configuration options for CORS.

Types ¶

type APIMuxConfig ¶

type APIMuxConfig struct {
	Shutdown chan os.Signal
	Log      *zap.SugaredLogger
	Auth     *auth.Auth
	DB       *sqlx.DB
	Broker   broker.Broker
}

APIMuxConfig contains all the mandatory systems required by handlers.

type Options ¶

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

Options represent optional parameters.

Source Files ¶

View all Source files

handlers.go

Directories ¶

Path	Synopsis
debug
checkgrp Package checkgrp maintains the group of handlers for health checking.	Package checkgrp maintains the group of handlers for health checking.
v1 Package v1 contains the full set of handler functions and routes supported by the v1 web api.	Package v1 contains the full set of handler functions and routes supported by the v1 web api.
candlegrp Package candlegrp maintains the group of handlers for candle access.	Package candlegrp maintains the group of handlers for candle access.
ordergrp Package ordergrp maintains the group of handlers for order access.	Package ordergrp maintains the group of handlers for order access.
positiongrp Package positiongrp maintains the group of handlers for position access.	Package positiongrp maintains the group of handlers for position access.
symbolgrp Package symbolgrp maintains the group of handlers for order access.	Package symbolgrp maintains the group of handlers for order access.
usergrp Package usergrp maintains the group of handlers for user access.	Package usergrp maintains the group of handlers for user access.

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