Swagger与knife4j的使用

• Swagger
  • 是一个规范和完整的框架，用于生成文档、描述接口、测试

• knife4j
  • 基于Swagger生成Api文档的增强解决方案

Swagger

主要作用：

1. 使得前后端分离开发更加方便，有利于团队协作
2. 接口的文档在线自动生成，降低后端开发人员编写接口文档的负担
3. 功能测试

SpringBoot集成Swagger

引入依赖

  io.springfox
  springfox-swagger2


  io.springfox
  springfox-swagger-ui

配置类

package com.项目.common.swagger;

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;


@Configuration
@EnableSwagger2
public class SwaggerConfiguration {

   @Bean
   public Docket buildDocket() {
      return new Docket(DocumentationType.SWAGGER_2)
              .apiInfo(buildApiInfo())
              .select()
              // 要扫描的API(Controller)基础包
              .apis(RequestHandlerSelectors.basePackage("com.heima"))
              .paths(PathSelectors.any())
              .build();
   }

   private ApiInfo buildApiInfo() {
      Contact contact = new Contact("Ethan","","");
      return new ApiInfoBuilder()
              .title("平台管理API文档")
              .description("后台api")
              .contact(contact)
              .version("1.0.0").build();
   }
}

使用自动装配加载

模块中添加文件：resources/META-INF/Spring.factories

org.springframework.boot.autoconfigure.EnableAutoConfiguration=\
  com.heima.common.swagger.SwaggerConfiguration

Swagger常用注解

在Java类中添加Swagger的注解即可生成Swagger接口文档，常用Swagger注解如下：

@Api：整个类，描述Controller的作用

@ApiOperation：描述一个类的方法，或者说一个接口

@ApiParam：单个参数的描述信息 ，前端接收的数据

@ApiModel：对象来接收参数 ，前端接收的数据

@ApiModelProperty：用对象接收参数时，描述对象的一个字段

@ApiResponse：HTTP响应其中1个描述

@ApiResponses：HTTP响应整体描述

@ApiIgnore：使用该注解忽略这个API

@ApiError ：发生错误返回的信息

@ApiImplicitParam：一个请求参数

@ApiImplicitParams：多个请求参数的描述信息

示例

@RestController
@RequestMapping("/api/v1/login")

@Api(value = "app端用户登录", tags = "ap_user", description = "app端用户登录API")
public class ApUserLoginController {

@Autowired
private ApUserService apUserService;

@PostMapping("/login_auth")
@ApiOperation("用户登录")
public ResponseResult login(@RequestBody LoginDto dto){return apUserService.login(dto);}
}

@Data
public class LoginDto {

/**
* 手机号
*/
@ApiModelProperty(value="手机号",required = true)
private String phone;

/**
* 密码
*/
@ApiModelProperty(value="密码",required = true)
private String password;
}

---

knife4j

Java MVC框架集成Swagger生成Api文档的增强解决方案

gitee地址：knife4j: knife4j是为Java MVC框架集成Swagger生成Api文档的工具,前身是swagger-bootstrap-ui

官方文档：knife4j

效果演示：http://knife4j.xiaominfo.com/doc.html

UI增强包

• 文档说明：接口的使用情况。
• 在线调试：测试工具测试接口是否正确。
• 离线文档：根据标准规范，生成的在线markdown离线文档

快速集成

在Swagger基础上再引入knife4j的起步依赖

     com.github.xiaoymin
     knife4j-spring-boot-starter

配置类

package com.heima.common.knife4j;

import com.github.xiaoymin.knife4j.spring.annotations.EnableKnife4j;
import org.springframework.context.annotation.Bean;
import org.springframework.context.annotation.Configuration;
import org.springframework.context.annotation.Import;
import springfox.bean.validators.configuration.BeanValidatorPluginsConfiguration;
import springfox.documentation.builders.ApiInfoBuilder;
import springfox.documentation.builders.PathSelectors;
import springfox.documentation.builders.RequestHandlerSelectors;
import springfox.documentation.service.ApiInfo;
import springfox.documentation.spi.DocumentationType;
import springfox.documentation.spring.web.plugins.Docket;
import springfox.documentation.swagger2.annotations.EnableSwagger2;

@Configuration
@EnableSwagger2
@EnableKnife4j
@Import(BeanValidatorPluginsConfiguration.class)
public class Swagger2Configuration {
    
    @Bean(value = "defaultApi2")
    public Docket defaultApi2() {
        Docket docket=new Docket(DocumentationType.SWAGGER_2)
            .apiInfo(apiInfo())
            //分组名称
            .groupName("1.0")
            .select()
            //这里指定Controller扫描包路径
            .apis(RequestHandlerSelectors.basePackage("com.haha"))
            .paths(PathSelectors.any())
            .build();
        return docket;
    }
    private ApiInfo apiInfo() {
        return new ApiInfoBuilder()
            .title("hahaAPI文档")
            .description("hahaAPI文档")
            .version("1.0")
            .build();
    }
}

添加自动装配

org.springframework.boot.autoconfigure.EnableAutoConfiguration=\
  com.heima.common.swagger.Swagger2Configuration, \
  com.heima.common.swagger.SwaggerConfiguration

注解说明

@EnableSwagger2

• 该注解是Springfox-swagger框架提供的使用Swagger注解，该注解必须加

@EnableKnife4j

• 该注解是knife4j提供的增强注解,Ui提供了例如动态参数、参数过滤、接口排序等增强功能,如果你想使用这些增强功能就必须加该注解，否则可以不用加

访问地址

http://host:port/doc.html