Spring Integration整合Swagger 2生成REST API文档可行性咨询

首先得明确：默认情况下Springfox Swagger只会识别Spring MVC的控制器，不会自动抓取Spring Integration的HTTP入站网关，所以需要做一些针对性配置，刚好适配你用的Spring Boot 2.0.1和Springfox 2.8.0版本。

1. 添加必要依赖 #

除了已有的springfox-swagger2，还需要两个依赖：

• 提供Spring Integration与Swagger整合支持的模块
• Swagger UI用于可视化查看文档

如果是Maven项目，在pom.xml中添加：

<dependency>
    <groupId>org.springframework.integration</groupId>
    <artifactId>spring-integration-swagger</artifactId>
    <version>5.0.4.RELEASE</version> <!-- 和Spring Boot 2.0.1适配的版本 -->
</dependency>
<dependency>
    <groupId>io.springfox</groupId>
    <artifactId>springfox-swagger-ui</artifactId>
    <version>2.8.0</version>
</dependency>

2. 修改Swagger Docket配置 #

调整你的Docket Bean，确保它能识别Integration的请求处理器，同时可以按需添加响应模型：

@Bean
public Docket api(TypeResolver typeResolver) {
    return new Docket(DocumentationType.SWAGGER_2)
            .select()
            .apis(RequestHandlerSelectors.any())
            .paths(PathSelectors.any())
            .build()
            .additionalModels(typeResolver.resolve(String.class)); // 对应你网关的请求/响应类型
}

3. 启用Integration的Swagger支持 #

在你的配置类上添加@EnableIntegrationSwagger注解，开启Spring Integration与Swagger的整合功能：

@Configuration
@EnableIntegration
@EnableIntegrationSwagger
@EnableSwagger2
public class IntegrationConfig {
    // 你的其他配置Bean...
}

4. 为HTTP入站网关添加Swagger元数据 #

在定义Http.inboundGateway时，通过swaggerDocumentation()方法配置API的文档信息，比如摘要、描述、操作ID等：

@Bean
public IntegrationFlow inbound() {
    return IntegrationFlows.from(Http.inboundGateway("/foo")
            .requestMapping(m -> m.methods(HttpMethod.GET))
            .requestPayloadType(String.class)
            .swaggerDocumentation(doc -> doc
                    .apiOperationId("getFoo")
                    .summary("获取Foo资源")
                    .description("处理GET请求，返回字符串格式的响应结果")))
            .channel("httpRequest")
            .get();
}

5. 验证效果 #

启动应用后，访问http://localhost:8080/swagger-ui.html，就能看到你定义的/foo接口已经出现在Swagger文档里啦！

内容的提问来源于stack exchange，提问作者Mateusz Lipiński