Package springfox.documentation.spring.web Description
Adds support for Spring Integration Http inbound adapters and gateways.
Builds upon the springfox webmvc and webflux implementations, but uses Spring Integration http endpoint
configurations to create documentation. Spring Integration currently organizes the WebFlux/WebMvc split as follows.
- spring-integration-webflux pulls in spring-integration-http, but not spring-webmvc;
for spring-webflux it assumes that spring-boot-starter-webflux is present
- spring-integration-http is necessary to use the Http endpoint, it does not pull in spring-webmvc;
for that it assumes that spring-boot-starter-web is present
Key extension points:
- SpringIntegrationDocumentationPluginBootstrapper bootstraps on ContextRefreshedEvent because that is when
IntegrationRequestMappingHandlerMapping detects handler methods - as opposed to DocumentationPluginBootstrapper,
which uses SmartLifecycle.
- WebFlux or WebMvc specific implementations are necessary to provide request handlers
Changes in existing code:
@Conditional(SpringIntegrationPluginNotPresentInClassPathCondition.class) on
DocumentationPluginsBootstrapper to avoid bootstrapping
the documentation plugins twice- Filter for Integration Handler Mappings in WebMvcRequestHandlerProvider and WebFluxRequestHandlerProvider
- See Also:
SpringIntegrationDocumentationPluginsBootstrapper