v1

package

v0.0.0-...-c2300e3 Latest Latest Go to latest Published: Dec 28, 2023 License: Apache-2.0 Imports: 28 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/nhaancs/bhms

Documentation ¶

Overview ¶

Package v1 manages the different versions of the API.

Index ¶

func APIMux(cfg APIMuxConfig, options ...func(opts *Options)) (http.Handler, error)
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, error)

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

func WithCORS ¶

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

WithCORS provides configuration options for CORS.

Types ¶

type APIMuxConfig ¶

type APIMuxConfig struct {
	Build    string
	Shutdown chan os.Signal
	Log      *logger.Logger
	Auth     *auth.Auth
	DB       *sqlx.DB
	Tracer   trace.Tracer
	KeyID    string
	SMS      *sms.SMS
}

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

v1.go

Directories ¶

Path	Synopsis
handlers
checkgrp Package checkgrp maintains the group of handlers for health checking.	Package checkgrp maintains the group of handlers for health checking.
divisiongrp Package divisiongrp ...	Package divisiongrp ...
propertygrp
unitgrp
usergrp Package usergrp maintains the group of handlers for user access.	Package usergrp maintains the group of handlers for user access.
paging Package paging provides support for query paging.	Package paging provides support for query paging.

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