# Functions
DefaultRouter creates a default implementation of the router.
Error creates a generic responder for returning errors, the data will be serialized with the matching producer for the request.
MatchedRouteFrom request context value.
NegotiateContentEncoding returns the best offered content encoding for the request's Accept-Encoding header.
NegotiateContentType returns the best offered content type for the request's Accept header.
NewContext creates a new context wrapper.
NewOperationExecutor creates a context aware middleware that handles the operations after routing.
NewRoutableContext creates a new context for a routable API.
NewRoutableContextWithAnalyzedSpec is like NewRoutableContext but takes as input an already analysed spec.
NewRouter creates a new context-aware router middleware.
NewUntypedRequestBinder creates a new binder for reading a request.
NotImplemented the error response when the response is not implemented.
PassthroughBuilder returns the handler, aka the builder identity function.
RapiDoc creates a middleware to serve a documentation site for a swagger spec.
Redoc creates a middleware to serve a documentation site for a swagger spec.
SecurityPrincipalFrom request context value.
SecurityScopesFrom request context value.
Serve serves the specified spec with the specified api registrations as a http.Handler.
ServeWithBuilder serves the specified spec with the specified api registrations as a http.Handler that is decorated by the Builder.
Spec creates a middleware to serve a swagger spec as a JSON document.
SwaggerUI creates a middleware to serve a documentation site for a swagger spec.
No description provided by the author
WithDefaultRouterLogger sets the debug logger for the default router.
WithDefaultRouterLoggerFunc sets a logging debug method for the default router.
WithSpecDocument sets the name of the JSON document served as a spec.
WithSpecPath sets the path to be joined to the base path of the Spec middleware.
WithTemplate allows to set a custom template for the UI.
WithUIBasePath sets the base path from where to serve the UI assets.
WithUIPath sets the path from where to serve the UI assets (i.e.
WithUISpecURL sets the path from where to serve swagger spec document.
WithUITitle sets the title of the UI.
# Structs
Context is a type safe wrapper around an untyped request context used throughout to store request context with the standard context attached to the http.Request.
MatchedRoute represents the route that was matched in this request.
RapiDocOpts configures the RapiDoc middlewares.
RedocOpts configures the Redoc middlewares.
RouteAuthenticator is an authenticator that can compose several authenticators together.
RouteParam is a object to capture route params in a framework agnostic way.
SwaggerUIOpts configures the SwaggerUI middleware.
UntypedRequestBinder binds and validates the data from a http request.
# Interfaces
RequestBinder is an interface for types to implement when they want to be able to bind from a request.
Responder is an interface for types to implement when they want to be considered for writing HTTP responses.
RoutableAPI represents an interface for things that can serve as a provider of implementations for the swagger router.
Router represents a swagger-aware router.
# Type aliases
A Builder can create middlewares.
DefaultRouterOpt allows to inject optional behavior to the default router.
ResponderFunc wraps a func as a Responder interface.
RouteAuthenticators represents a group of authenticators that represent a logical OR.
RouteParams the collection of route params.
SpecOption can be applied to the Spec serving middleware.
UIOption can be applied to UI serving middleware, such as Context.APIHandler or Context.APIHandlerSwaggerUI to alter the defaut behavior.