Documentation
¶
Index ¶
Constants ¶
This section is empty.
Variables ¶
This section is empty.
Functions ¶
This section is empty.
Types ¶
type DocController ¶
type DocController struct {
qcontrollers.MethodNotAllowedController
qcontrollers.BasicAuthenticatedController
Specification *config.Specification
}
DocController renders the autogenerated api documentation
func NewDocController ¶
func NewDocController(spec *config.Specification) *DocController
NewDocController returns an initialized DocController
func (*DocController) Get ¶
func (controller *DocController) Get(context *qhttp.Context)
Get renders the documentation HTML
func (*DocController) GetRoutes ¶
func (controller *DocController) GetRoutes() []string
GetRoutes establishes routes for the RegistrationsController
type EchoController ¶
type EchoController interface {
qhttp.Controller
}
EchoController is a debugging tool for echo'ing back the request sent in as the body of the response
func NewEchoController ¶
func NewEchoController(spec *config.Specification) EchoController
NewEchoController returns an initialized EchoController
type ResourceController ¶
type ResourceController interface {
qhttp.Controller
}
ResourceController is a is a sample controller implementation
func NewResourceController ¶
func NewResourceController(spec *config.Specification) ResourceController
NewResourceController returns an initialized ResourceController
type WidgetController ¶
type WidgetController interface {
qhttp.Controller
// contains filtered or unexported methods
}
WidgetController handles Read, Update, Replace and Delete for a single Widget
func NewWidgetController ¶
func NewWidgetController(spec *config.Specification) WidgetController
NewWidgetController returns an initialized WidgetController
type WidgetsController ¶
type WidgetsController interface {
qhttp.Controller
// contains filtered or unexported methods
}
WidgetsController handles List and Create functions for the Widget Collection
func NewWidgetsController ¶
func NewWidgetsController(spec *config.Specification) WidgetsController
NewWidgetsController returns an initialized WidgetsController