Spring Boot集成Knife4j

一、介绍

Knife4j【快速开始】是为Java MVC框架集成Swagger生成API文档的增强解决方案(在非Java项目中也提供了前端UI的增强解决方案),前身是Swagger2,取名Knife4j是希望她能像一把匕首一样小巧、轻量,并且功能强悍。

Knife4j

二、开源仓库

  • Github
https://github.com/xiaoymin/swagger-bootstrap-ui
  • 码云
https://gitee.com/xiaoym/knife4j

三、功能特性

  • 简洁
    基于左右菜单式的布局方式,更符合国人的操作习惯,文档更清晰
  • 个性化配置
    支持接口地址、接口description属性、UI增强等个性化配置
  • 增强
    接口排序、Swagger资源保护、导出Markdown、参数缓存等众多强大功能

核心功能

该UI增强包主要包括两大核心功能:文档说明在线调试

  • 文档说明:根据Swagger的规范说明,详细列出接口文档的说明,包括接口地址、类型、请求示例、请求参数、响应示例、响应参数、响应码等信息,使用swagger-bootstrap-ui能根据该文档说明,对该接口的使用情况一目了然
  • 在线调试:提供在线接口联调的强大功能,自动解析当前接口参数,同时包含表单验证,调用参数可返回接口响应内容、Header、Curl请求命令实例、响应时间、响应状态码等信息,帮助开发者在线调试,而不必通过其他测试工具测试接口是否正确,简洁、强大。

UI增强

同时,swagger-bootstrap-ui在满足以上功能的同时,还提供了文档的增强功能,每一个增强的功能都是贴合实际,考虑到开发者的实际开发需要,是必不可少的功能,主要包括:

  • 个性化配置:通过个性化UI配置项,可自定义UI的相关显示信息
  • 离线文档:Knife4j提供导出4种格式的离线文档(HTML、Markdown、Word、PDF)
  • 接口排序:自1.8.5后,UI支持了接口排序功能,例如一个注册功能包含了多个步骤,可以根据swagger-bootstrap-ui提供的接口排序规则实现接口的排序,步骤化接口操作,方便其他开发者进行接口对接
  • 全局搜索:搜索关键字主要包括:URL地址、接口说明、方法类型、接口描述

四、功能预览

  • pom.xml
<!-- https://mvnrepository.com/artifact/com.github.xiaoymin/knife4j-spring-boot-starter -->
<dependency>
    <groupId>com.github.xiaoymin</groupId>
    <artifactId>knife4j-spring-boot-starter</artifactId>
    <version>2.0.4</version>
</dependency>
  • Swagger2Config
package game.leif.fantasy_all_star;

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.service.Contact;
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 Swagger2Config {
    @Bean
    public Docket createRestApi() {
        return new Docket(DocumentationType.SWAGGER_2)
                .apiInfo(apiInfo())
                .select()
                .apis(RequestHandlerSelectors.basePackage("game.leif.fantasy_all_star.controller"))
                .paths(PathSelectors.any())
                .build();
    }

    private ApiInfo apiInfo() {
        return new ApiInfoBuilder()
                .title("Fantasy All Star - 接口文档")
                .description("本项目模拟了回合制对战类游戏,让玩家能够体验到来自不同游戏、动漫、影视、小说中的经典人物互相组队对战的畅爽快感。")
                .contact(new Contact("Leif Liu", null, "leif1995@dingtalk.com"))
                .version("v1.0.0")
                .build();
    }
}
  • filter
filterURLSet.add("/swagger-resources");
filterURLSet.add("/v2/api-docs");
filterURLSet.add("/v2/api-docs-ext");
#Knife4j
location ^~ /knife4j {
    proxy_pass http://192.168.2.192:20300/api/doc.html;
}
location ^~ /webjars/ {
    proxy_pass http://192.168.2.192:20300/api/webjars/;
}
location ^~ /swagger-resources {
    proxy_pass http://192.168.2.192:20300/api/swagger-resources;
}
location ^~ /v2/api-docs {
    proxy_pass http://192.168.2.192:20300/api/v2/api-docs;
}
  • Controller
@Api(value = "用户", tags = {"用户"})
@ApiOperation(value = "登陆接口", notes = "用于用户登陆")
@ApiImplicitParams({
        @ApiImplicitParam(name = "response", value = "参数用例", required = false, dataType = DataTypeConstants.STRING, paramType = RequestTypeConstants.QUERY)
})
@ApiResponses({
        @ApiResponse(code = 1, message = "自定义响应状态码")
})
@ApiOperationSupport(order = 1, params = @DynamicParameters(name = "CreateOrderModel",properties = {
        @DynamicParameter(name = "id",value = "注解id",example = "X000111",required = true,dataTypeClass = Integer.class),
        @DynamicParameter(name = "name",value = "订单编号",required = false)
}), responses = @DynamicResponseParameters(properties = {
        @DynamicParameter(name = "result", value = "返回结果", dataTypeClass = String.class)
}))
  • View Object
@ApiModel(description = "登陆表单")
@ApiModelProperty(value = "用户名", required = true, example = "leif", position = 1)
  • application.yml
# 是否停用Knife4j文档
knife4j:
  production: false
接口文档

在线调试

全局参数设置

离线文档

个性化设置