如何在java中的springboot快速集成Swagger2集成公共服务

<!-- swagger -->
<dependency>
    <groupId>io.springfox</groupId>
    <artifactId>springfox-swagger-ui</artifactId>
    <version>2.4.0</version>
</dependency>
<dependency>
    <groupId>io.springfox</groupId>
    <artifactId>springfox-swagger2</artifactId>
    <version>2.4.0</version>
</dependency>
1.
2.
3.
4.
5.
6.
7.
8.
9.
10.
11.

package com.common.base.config;
 
import com.common.base.utils.StringUtil;
import com.common.base.utils.YamlUtil;
import org.springframework.beans.factory.annotation.Autowired;
import org.springframework.boot.autoconfigure.condition.ConditionalOnProperty;
import org.springframework.context.annotation.Bean;
import org.springframework.context.annotation.Configuration;
import springfox.documentation.builders.ApiInfoBuilder;
import springfox.documentation.builders.PathSelectors;
import springfox.documentation.builders.RequestHandlerSelectors;
import springfox.documentation.service.ApiInfo;
import springfox.documentation.service.Contact;
import springfox.documentation.spi.DocumentationType;
import springfox.documentation.spring.web.plugins.Docket;
import springfox.documentation.swagger2.annotations.EnableSwagger2;
 
/**
 * @Auther: tony_t_peng
 * @Date: 2020-08-14 15:42
 * @Description:
 */
@Configuration
//是否开启swagger，正式环境一般是需要关闭的（避免不必要的漏洞暴露！），可根据springboot的多环境配置进行设置
@ConditionalOnProperty(name = "swagger.enable",  havingValue = "true")
@EnableSwagger2
public class Swagger2Config {
 
    @Autowired
    private ProfileConfig profileConfig;
 
    private static final String SWAGGER_BASE_PACKAGE="swagger.base.package";
 
 
 
    // swagger2的配置文件，这里可以配置swagger2的一些基本的内容，比如扫描的包等等
    @Bean
    public Docket createRestApi() {
        String active = profileConfig.getActiveProfile();//读取当前的环境active
        String swaggerBasePackage = YamlUtil.getApplicationVal(SWAGGER_BASE_PACKAGE,active);
        return new Docket(DocumentationType.SWAGGER_2)
                .apiInfo(apiInfo())
                .select()
                // 为当前包路径
                .apis(RequestHandlerSelectors.basePackage(swaggerBasePackage)).paths(PathSelectors.any())
                .build();
    }
    // 构建 api文档的详细信息函数,注意这里的注解引用的是哪个
    private ApiInfo apiInfo() {
        return new ApiInfoBuilder()
                // 页面标题
                .title("Swagger2 构建RESTful API")
                // 创建人信息
                .contact(new Contact("TONY_T_PENG",  "",  ""))
                // 版本号
                .version("1.0")
                // 描述
                .description("API 描述")
                .build();
    }
}
1.
2.
3.
4.
5.
6.
7.
8.
9.
10.
11.
12.
13.
14.
15.
16.
17.
18.
19.
20.
21.
22.
23.
24.
25.
26.
27.
28.
29.
30.
31.
32.
33.
34.
35.
36.
37.
38.
39.
40.
41.
42.
43.
44.
45.
46.
47.
48.
49.
50.
51.
52.
53.
54.
55.
56.
57.
58.
59.
60.
61.

/**
 * @Auther: tony_t_peng
 * @Date: 2020-08-07 15:35
 * @Description: 获取profile.active提供方法，此方法可以在sping容器完成创建之前，
 * 获取环境参数
 */
@Configuration
@AutoConfigureOrder(0)
public class ProfileConfig {
 
 
    @Autowired
    private ApplicationContext context;
 
    public String getActiveProfile() {
        return context.getEnvironment().getActiveProfiles()[0];
    }
 
}
1.
2.
3.
4.
5.
6.
7.
8.
9.
10.
11.
12.
13.
14.
15.
16.
17.
18.
19.

@RestController
@RequestMapping("/question")
@Api("questionController相关的api")
public class QuestionController {
 
    public static Logger logger = LoggerFactory.getLogger(QuestionController.class);
 
    @Autowired
    private UwConvertQuestionService convertQuestionService;
 
    @RequestMapping(value = "/test",method = RequestMethod.POST)
    @ApiOperation(value = "测试",tags={"测试标题"}, notes = "标题内容",httpMethod = "POST")
    public Result<ConvertQuestionResponseMO> test(@RequestBody @Valid ConvertQuestionRequestMO request)
    {
         
        return null;
    }
 
 
}
1.
2.
3.
4.
5.
6.
7.
8.
9.
10.
11.
12.
13.
14.
15.
16.
17.
18.
19.
20.

swagger:
  enable: true
  base:
    package: com.XXX.controller
1.
2.
3.
4.