api

package

v0.5.2 Latest Latest Go to latest Published: Oct 3, 2024 License: MPL-2.0 Imports: 4 Imported by: 0

Documentation ¶

Package api contains the client-facing layers, such as, the RESTful endpoints where clients can interact with the API.

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 adds support for RESTful endpoints.	Package controllers adds support for RESTful endpoints.
graphql Package graphql package	Package graphql package
loader Package loader package	Package loader package
resolver Package resolver contains functionality for interacting with the API via GraphQL.	Package resolver contains functionality for interacting with the API via GraphQL.
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.
grpc Package grpc implements gRPC functionality.	Package grpc implements gRPC functionality.
reader Package reader implements a size-limited reader for uploading templates of multiple kinds.	Package reader implements a size-limited reader for uploading templates of multiple kinds.
servers Package servers implements the gRPC servers.	Package servers implements the gRPC servers.
middleware Package middleware allows adding custom middleware(s) to the RESTful API, such as, JWT based authentication.	Package middleware allows adding custom middleware(s) to the RESTful API, such as, JWT based authentication.
response Package response providers support for returning http responses	Package response providers support for returning http responses
urn Package urn provides the PRN (Phobos Resource Name) functionalities.	Package urn provides the PRN (Phobos Resource Name) functionalities.