Builds the documentation for all the endpoints discovered in an API.
Builds the documentation for all the endpoints discovered in an API.
Returns a list of operations based on the given route.
Returns a list of operations based on the given route. The default implementation returns a list with only 1 operation.
Initializes the kernel.
Initializes the kernel. Used to provide context that is unavailable
when the instance is constructed, for example the servlet lifecycle.
Should set the config
variable to the parameter.
the configuration.
The currently registered model descriptions for swagger
The currently registered model descriptions for swagger
a map of swagger models
Registers a model for swagger, this method reflects over the class and collects all non-primitive classes and adds those to the swagger defintion
Registers a model for swagger, this method reflects over the class and collects all non-primitive classes and adds those to the swagger defintion
the class of the model to register
Registers a model for swagger
Registers a model for swagger
the model to add to the swagger definition
(Since version 2.1.0) Do not invoke directly. Use withRequest
to change the binding, or request to get the value
(Since version 2.1.0) Do not invoke directly. Use withResponse
to change the binding, or response
to get the value
(Since version 2.1.0) Use servletContext instead
(Since version 2.3.1) This field is no longer used, due to changes in Swagger spec 1.2
(Since version 2.2) Use the apiOperation.errors
and operation
methods to build swagger descriptions of endpoints
(Since version 2.2) This implicit conversion will be removed in the future
(Since version 2.2) Use registerModel[T]
or registerModel(model)
instead, this method will be removed in the future
(Since version 2.2) Use the apiOperation.nickname
and operation
methods to build swagger descriptions of endpoints
(Since version 2.2) Use the apiOperation.notes
and operation
methods to build swagger descriptions of endpoints
(Since version 2.2) Use the apiOperation.parameters
and operation
methods to build swagger descriptions of endpoints
(Since version 2.2) Use the apiOperation.responseClass
and operation
methods to build swagger descriptions of endpoints
(Since version 2.2) Use the variant where you use a type parameter, this method doesn't allow for reflection and requires you to manually ad the model
(Since version 2.1.0) Use status_=(Int) instead
(Since version 2.2) Use the apiOperation.summary
and operation
methods to build swagger descriptions of endpoints
(Since version 2.2.2) Swagger spec 1.2 renamed this to swaggerDefaultMessages, please use that one
Provides the necessary support for adding documentation to your routes.