api

package

v1.1.1 Latest Latest Go to latest Published: Jun 13, 2021 License: Apache-2.0 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

View Source

const (
	// JwtExpirationHoursDefault the default expiration of JWTs in hours
	JwtExpirationHoursDefault = 3
)

This section is empty.

func AddRouter(config *apiConfig.HTTPConfig, db *gorm.DB) (*mux.Router, error)

AddRouter returns a new router based on the API configuration. Leverages database for handlers

func Logger(inner http.Handler, name string) http.Handler

Logger adds a handler for the logger

func NewRouter(config *config.HTTPConfig, db *gorm.DB) *mux.Router

NewRouter returns a new router

type Route struct {
	Name        string
	Method      string
	Pattern     string
	HandlerFunc http.HandlerFunc
}

Route handles the routes for the API map a method and pattern to the appropriate handler

type Routes []Route

Routes slice of routes

type Server struct {
	*http.Server
	DB     *gorm.DB
	Config *apiConfig.HTTPConfig
}

Server represents an API server

func NewServer(config *apiConfig.HTTPConfig, db *gorm.DB) (*Server, error)

NewServer returns a new API server with middleware and route

func (srv *Server) Start()

Start runs ListenAndServe on the http.Server with graceful shutdown.

Path	Synopsis
handlers