Package org.springdoc.core.filters
Interface OpenApiMethodFilter
- All Known Subinterfaces:
GlobalOpenApiMethodFilter
- Functional Interface:
- This is a functional interface and can therefore be used as the assignment target for a lambda expression or method reference.
Implement and register a bean of type
OpenApiMethodFilter
to
conditionally include any detected methods in default OpenAPI descriptions
but not groups- Author:
- michael.clarke
- See Also:
-
Method Summary
Modifier and TypeMethodDescriptionboolean
isMethodToInclude
(Method method) Whether the given method should be included in the generated OpenApi definitions.
-
Method Details
-
isMethodToInclude
Whether the given method should be included in the generated OpenApi definitions. Only methods from classes detected by the relevant loader will be passed to this filter; it cannot be used to load methods that are not annotated with `RequestMethod` or similar mechanisms. Methods that are rejected by this filter will not be processed any further, although methods accepted by this filter may still be rejected by other checks, such as package inclusion checks so may still be excluded from the final OpenApi definition.- Parameters:
method
- the method to perform checks against- Returns:
- whether this method should be used for further processing
-