SpringBoot整合Swagger2

SpringBoot整合Swagger2

一.配置

1. 导入依赖

   
   io.springfox
   springfox-swagger2
   2.6.1
   

       <dependency>
           <groupId>io.springfox</groupId>
           <artifactId>springfox-swagger-ui</artifactId>
           <version>2.6.1</version>
   

2. 配置类的编写

   @Configuration
   @EnableSwagger2
   public class SwaggerConfig {

   @Bean
   public Docket createRestApi() {
       return new Docket(DocumentationType.SWAGGER_2)
               .apiInfo(apiInfo())
               .select()
               // 扫描指定包中的swagger注解
               .apis(RequestHandlerSelectors.basePackage("com.zy.controller"))
               //这种方式就是指定到一个具体类.扫描其注解
               //.apis(RequestHandlerSelectors.withMethodAnnotation(ApiOperation.class))
   
               .paths(PathSelectors.any())
               .build();
   }
   private ApiInfo apiInfo() {
       return new ApiInfoBuilder()
               .title("springboot利用swagger构建api文档-zy")
               .description("哈哈哈哈easy_report试水")
               .termsOfServiceUrl("www.baidu.com")
               .version("1.0")
               .build();
   }
   

   }

二.注解

swagger通过注解表明该接口会生成文档，包括接口名、请求方法、参数、返回信息的等等。

• @Api：修饰整个类，描述Controller的作用
• @ApiOperation：描述一个类的一个方法，或者说一个接口
• @ApiParam：单个参数描述
• @ApiModel：用对象来接收参数
• @ApiProperty：用对象接收参数时，描述对象的一个字段
• @ApiResponse：HTTP响应其中1个描述
• @ApiResponses：HTTP响应整体描述
• @ApiIgnore：使用该注解忽略这个API
• @ApiError ：发生错误返回的信息
• @ApiParamImplicitL：一个请求参数

• @ApiParamsImplicit 多个请求参数

  @ApiOperation(value=”更新信息”, notes=”根据url的id来指定更新图书信息”)
  @ApiImplicitParams({
  @ApiImplicitParam(name = “id”, value = “图书ID”, required = true, dataType = “Long”,paramType = “path”),
  @ApiImplicitParam(name = “book”, value = “图书实体book”, required = true, dataType = “Book”)
  })
  @RequestMapping(value=”/{id}”, method= RequestMethod.PUT)
  public String putUser(@PathVariable Long id, @RequestBody Book book) {
  Book book1 = books.get(id);
  book1.setName(book.getName());
  book1.setPrice(book.getPrice());
  books.put(id, book1);
  return “success”;
  }

注意:如果是取路径上的参数,@ApiImplicitParam后要加paramType = “path”

 @ApiIgnore//使用该注解忽略这个API
    @RequestMapping(value = "/hi", method = RequestMethod.GET)
    public String  jsonTest() {
        return " hi you!";
    }

三.启动

启动工程，访问：http://localhost:8080/swagger-ui.html ，就看到swagger-ui:

四.UI升级

替换UI包

<dependency>
    <groupId>com.github.xiaoymin</groupId>
    <artifactId>swagger-bootstrap-ui</artifactId>
    <version>1.6</version>
</dependency>

访问路径

http://localhost:8080/doc.html 即可