@CompileStatic class SpringdocSelection extends OpenApiSelection implements ActionHooks
What a document springdoc serves selects: its criteria, and the method filters and operation customizers springdoc applies to its handler methods, applied to the Grails actions too.
A filter or customizer that fails, such as one that reads the current request where there is none, is skipped and logged, rather than the action it was applied to.
| Properties inherited from class | Properties |
|---|---|
class OpenApiSelection |
consumesToMatch, displayName, group, headersToMatch, packagesToExclude, packagesToScan, pathsToExclude, pathsToMatch, producesToMatch |
| Constructor and description |
|---|
SpringdocSelection(OpenApiSelection criteria, java.util.Collection<? extends org.springdoc.core.filters.OpenApiMethodFilter> methodFilters, java.util.Collection<? extends org.springdoc.core.customizers.OperationCustomizer> operationCustomizers) |
| Type Params | Return Type | Name and description |
|---|---|---|
|
io.swagger.v3.oas.models.Operation |
customize(io.swagger.v3.oas.models.Operation operation, io.swagger.v3.oas.models.Components components, GrailsControllerClass controller, java.lang.reflect.Method action)A customizer is given the handler method springdoc would give it for a Spring MVC endpoint: the controller bean, by name, as Spring MVC registers a handler, and the method the action is declared as. |
|
static org.springdoc.core.customizers.SpringDocCustomizers |
customizers(BeanFactory beanFactory)springdoc's customizers, where springdoc is configured in the context. |
|
static SpringdocSelection |
defaultSelection(OpenApiSelection criteria, org.springdoc.core.customizers.SpringDocCustomizers customizers)The default document selects what the criteria select, among the actions every springdoc method filter includes, and gives each operation to springdoc's operation customizers. |
|
static SpringdocSelection |
groupSelection(org.springdoc.core.models.GroupedOpenApi group, org.springdoc.core.customizers.SpringDocCustomizers customizers, org.springdoc.core.properties.SpringDocConfigProperties properties)A group selects what its criteria select, among the actions its method filters and the global ones include, and gives each operation to its operation customizers and the global ones. |
|
static org.springdoc.core.properties.SpringDocConfigProperties |
properties(BeanFactory beanFactory)springdoc's configuration, where springdoc is configured in the context. |
|
boolean |
selectsAction(java.lang.reflect.Method action) |
A customizer is given the handler method springdoc would give it for a Spring MVC endpoint: the controller bean, by name, as Spring MVC registers a handler, and the method the action is declared as. The controller is not created for it.
springdoc's customizers, where springdoc is configured in the context.
The default document selects what the criteria select, among the actions every springdoc method filter includes, and gives each operation to springdoc's operation customizers.
A group selects what its criteria select, among the actions its method filters and the global ones include, and gives each operation to its operation customizers and the global ones.
springdoc's configuration, where springdoc is configured in the context.