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 注意用自己的端口號