Documentation
¶
Overview ¶
Package api provides controllers for each api endpoint. Controllers are "dumb wiring"; there is little to no application logic in this package. Controllers call and coordinate other packages to satisfy the api endpoint. Authentication and authorization happen in controllers.
Index ¶
Constants ¶
View Source
const (
API_ROOT = "/api/v1/"
)
Variables ¶
View Source
var ( // Error when Request Manager is shutting down and not starting new requests ErrShuttingDown = errors.New("Request Manager is shutting down - no new requests are being started") )
Functions ¶
This section is empty.
Types ¶
type API ¶
type API struct {
// contains filtered or unexported fields
}
API provides controllers for endpoints it registers with a router. It satisfies the http.HandlerFunc interface.
func NewAPI ¶
NewAPI creates a new API struct. It initializes an echo web server within the struct, and registers all of the API's routes with it. @todo: create a struct of managers and pass that in here instead?
Click to show internal directories.
Click to hide internal directories.