package
0.2.10
Repository: https://github.com/mwm-io/gapi.git
Documentation: pkg.go.dev

# Functions

BuildOperation adds the given h to the openapi3.Reflector.
NewDocBuilder returns a new doc.DocBuilder.
NewRapiDocHandler build a new RapiDocHandler.
NewRapiDocReceiverHandler build a new RapiDocReceiverHandler.
NewSpecOpenAPIHandler builds a new SpecOpenAPIHandler, serving the api definition from the openapi3.Reflector, and checking auth access with the given Authorization.
PopulateReflector will add all the router routes into the given openapi3.Reflector You can add ignoredPath to ignore some registered routes.
WithDescription adds a description to documented element.
WithExample add an example to documented element.
WithHeaders add headers the documented element.
WithMimeType add precision about type/format (or override default value) to documented element.
WithRedirect add a redirection response to the documented element.
WithStatusCode override default status code to documented element.

# Constants

DefaultDocURI is the URI used to host documentation UI.
DefaultSpecOpenAPIURI is the URI used to host the openapi file generated by this package.
DocPageTitle is the URI used to host documentation UI.

# Variables

Config is the default doc generator config.

# Structs

DocBuilder is a builder to simplify the documentation of an operation.
RapiDocHandler is a server.SpecOpenAPIHandler that will serve a html page with rapidoc loading the given openAPIJsonURL.
RapiDocReceiverHandler is a server.SpecOpenAPIHandler that will serve the rapidoc oauth receiver.
SpecOpenAPIHandler is a server.SpecOpenAPIHandler that will return a json openapi definition of the given reflector.

# Interfaces

Authorization is able to determine whether a request is allowed to access the documentation or not.
Documented is able to describe itself as an openapi3 operation.

# Type aliases

BuilderOption can be used to override default value or add precision to documented element.