Swagger2配置和使用

1.pom.xml引入

<dependency>

        <groupId>io.springfox</groupId>

        <artifactId>springfox-swagger2</artifactId>

       <version>2.9.2</version>

</dependency>
<dependency>

        <groupId>io.springfox</groupId>

        <artifactId>springfox-swagger-ui</artifactId>

       <version>2.9.2</version>

</dependency>

2. 新增Swagger2Config类

@Configuration
@EnableSwagger2
public class Swagger2Config {
   //是否启用
   @Value("${swagger.enable:true}")
   private boolean enableSwagger;


   @Bean
  public Docket createRestApi(){
     return new Docket(DocumentationType.SWAGGER_2)
               .apiInfo(apiInfo())
               .groupName("组名称")
               .enable(enableSwagger)
               .select()
               .api(RequestHandlerSelectors.basePackage("com.xxx"))
               .build();

  }

   private ApiInfo apiInfo(){
       return new ApiInfoBuilder()
                 .title("接口文档")
                 .concact(new Concact("项目名称","",""))
                 .description("接口描述")
                 .termOfServiceUrl("")
                 .version("1.0")
                  .build();

   }
    



}

3. application.yml添加配置项，如果spirng boot版本2.6+，则需要添加

spring.mvc.pathmatch.matching-strategy: ANT_PATH_MATCHER

swagger.enable: true
spring.mvc.pathmatch.matching-strategy: ANT_PATH_MATCHER

4.Controller类添加注解

@Slf4j
@RestController
@RequestMapping("/test")
@Api(tags="测试Controller")
public class MyController{


  @PostMapping("syncRiskyIp")
  @ApiOperation(value="同步风险接口")
  public ResponseBean syncRiskyIp (@RequestBody List<ParameterSyncRiskyIP> parameterSyncRiskyIP){
    List list = new ArrayList<>();
     list.add("sync success");
   return ResponseBean.success(list) 
 }


}