api

package

v0.20.0 Latest Latest Go to latest Published: Apr 30, 2024 License: MPL-2.0 Imports: 4 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

Package api package

This section is empty.

This section is empty.

This section is empty.

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

RouteBuilder is used to build a Router instance

func NewRouteBuilder(middlewares ...func(http.Handler) http.Handler) *RouteBuilder

NewRouteBuilder creates an instance of RouterBuilder

func (rb *RouteBuilder) AddHandler(pattern string, handler http.Handler, middlewares ...func(http.Handler) http.Handler) *RouteBuilder

AddHandler adds the handler to the path

func (rb *RouteBuilder) AddHandlerFunc(method string, pattern string, handler http.HandlerFunc) *RouteBuilder

AddHandlerFunc adds a handler function to the router for a specific pattern

func (rb *RouteBuilder) AddRoutes(controller controllers.Controller) *RouteBuilder

AddRoutes adds the controllers routes to the path

func (rb *RouteBuilder) Router() chi.Router

Router returns and instance of a chi.Router with all routes added

func (rb *RouteBuilder) SubRouteBuilder(subPath string) *RouteBuilder

SubRouteBuilder returns a RouteBuilder under the given subpath

func (rb *RouteBuilder) WithSubRouter(subPath string, middlewares ...func(http.Handler) http.Handler) *RouteBuilder

WithSubRouter mounts a router under the current RouteBuilder with the given subpath

Path	Synopsis
controllers Package controllers package	Package controllers package
tfe Package tfe package	Package tfe package
graphql Package graphql package	Package graphql package
loader Package loader package	Package loader package
resolver Package resolver package	Package resolver package
schema Package schema contains all of the Schema Definition Files (abbreviated SDL) which define this API.	Package schema contains all of the Schema Definition Files (abbreviated SDL) which define this API.
middleware Package middleware package	Package middleware package
response Package response providers support for returning http responses	Package response providers support for returning http responses