IDEA Springboot集成Swagger2

1, 添加依赖
2, 配置Swagger2
3, 启动工程，访问Swagger页面

1, 添加下面依赖

  <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>

2, 配置Swagger2

创建类与启动类在同一目录

内容如下

  package com.moding.taili;

  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;

  //swagger2的配置文件，在项目的启动类的同级文件建立
  @Configuration
  @EnableSwagger2
  public class SwaggerConfig {
      // swagger2的配置文件，这里可以配置swagger2的一些基本的内容，比如扫描的包等等
      @Bean
      public Docket createRestApi() {
          return new Docket(DocumentationType.SWAGGER_2)
            .apiInfo(apiInfo())
            .groupName("Taili-V1.0")
            .select()
            //设定扫描接口的包basePackage(""),withClassAnnotation(RestController.class))
            .apis(RequestHandlerSelectors.basePackage("com.moding.taili.def.controller"))
            //过滤某些访问路径下的接口eg：扫描一个controller下的 /hello/xxx路径下的接口
            .paths(PathSelectors.any())
            .build();
      }
      // 构建 api文档的详细信息函数,注意这里的注解引用的是哪个
      private ApiInfo apiInfo() {
          return new ApiInfoBuilder()
            // 页面标题
            .title("台历项目 构建RESTful API")
            // 创建人信息
            .contact(new Contact("于强",  "",  "[e-mail]"))
            // 版本号
            .version("1.0")
            // 描述
            .description("API 接口描述")
            .build();
      }
  }

在启动类中添加启动Swagger注解

在类和函数中添加Swagger注解

  package com.moding.taili.def.controller;

  import io.swagger.annotations.Api;
  import io.swagger.annotations.ApiImplicitParam;
  import io.swagger.annotations.ApiOperation;
  import org.springframework.web.bind.annotation.*;
  import java.util.HashMap;
  import java.util.Map;

  @RestController
  @RequestMapping("api")
  @Api(value = "文章表接口", tags = "文章表接口")
  public class DemoController {

      @GetMapping("/get/{id}")
      @ApiOperation(value = "测试代码,根据ID返回相应数据",notes="查询设备信息")
      @ApiImplicitParam(name="id",value="设备ID",paramType = "path", required = true, dataType = "Integer")
      public Map<String,String> Test(@PathVariable int id){

          Map<String,String> result=new HashMap<>();
          result.put("success","ok");
          return result;
      }


      @GetMapping("/page")
      @ApiOperation(value="查询(分页)")
      public Map<String,Object>  pageCategory(@RequestParam(value="start",defaultValue="0")int start, @RequestParam(value = "size", defaultValue =  "5") int size) throws Exception {

          Map<String,Object> result = new HashMap<String,Object>();
          result.put("respCode", "01");
          result.put("respMsg", "成功");
          return result;
      }
  }

也可以在Model类中为属性添加注解

3, 启动工程，访问Swagger页面

swagger页面地址： http://localhost:8081/swagger-ui.html 注意用自己的端口号