一款超好用的 API 文档生成框架，国产开源，Star 4.8K+

最新推荐文章于 2024-10-18 12:42:15 发布

Java精选

最新推荐文章于 2024-10-18 12:42:15 发布

阅读量974

点赞数

原文链接：https://mp.weixin.qq.com/s?__biz=MzAwMTE3MDY4MQ==&mid=2652447582&idx=1&sn=a1962291650d604b0a39f69b03cc575e&chksm=81304ec8b647c7de3674bd95951c7a9d420cc97273a71d34b3208d14ec5f0bd71dde38154727&scene=126&&sessionid=0

版权

点击上方“Java精选”，选择“设为星标”

别问别人为什么，多问自己凭什么！

下方有惊喜留言必回，有问必答！

每天 08:35 更新文章，每天进步一点点...

介绍

knife4j是为Java MVC框架集成Swagger生成Api文档的增强解决方案,前身是swagger-bootstrap-ui,取名kni4j是希望它能像一把匕首一样小巧,轻量,并且功能强悍!

knife4j的前身是swagger-bootstrap-ui，为了契合微服务的架构发展,由于原来swagger-bootstrap-ui采用的是后端Java代码+前端Ui混合打包的方式,在微服务架构下显的很臃肿,因此项目正式更名为knife4j。

目前项目主要的模块如下：

此示例根据官方文档介绍演示。

开源仓库

Github

https://github.com/xiaoymin/swagger-bootstrap-ui

码云

https://gitee.com/xiaoym/knife4j

核心功能

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

文档说明：根据Swagger的规范说明，详细列出接口文档的说明，包括接口地址、类型、请求示例、请求参数、响应示例、响应参数、响应码等信息，使用swagger-bootstrap-ui能根据该文档说明，对该接口的使用情况一目了然。

在线调试：提供在线接口联调的强大功能，自动解析当前接口参数,同时包含表单验证，调用参数可返回接口响应内容、headers、Curl请求命令实例、响应时间、响应状态码等信息，帮助开发者在线调试，而不必通过其他测试工具测试接口是否正确,简介、强大。

UI增强

同时，swagger-bootstrap-ui在满足以上功能的同时，还提供了文档的增强功能，这些功能是官方swagger-ui所没有的，每一个增强的功能都是贴合实际，考虑到开发者的实际开发需要,是比不可少的功能，主要包括：

个性化配置：通过个性化ui配置项，可自定义UI的相关显示信息
离线文档：根据标准规范，生成的在线markdown离线文档，开发者可以进行拷贝生成markdown接口文档，通过其他第三方markdown转换工具转换成html或pdf，这样也可以放弃swagger2markdown组件
接口排序：自1.8.5后，ui支持了接口排序功能，例如一个注册功能主要包含了多个步骤,可以根据swagger-bootstrap-ui提供的接口排序规则实现接口的排序，step化接口操作，方便其他开发者进行接口对接

快速开始

相信使用过springboot的人大都知道和用过swagger，knife4j的使用方法和swagger几乎一模一样，没有什么学习成本，不同的是展示的接口UI文档更加友好和人性化。下面开始演示一个集成项目，首先来看pom文件依赖：

<dependency>
    <groupId>com.github.xiaoymin</groupId>
    <artifactId>knife4j-spring-boot-starter</artifactId>
    <version>1.9.6</version>
</dependency>

只引入一个knife4j的starter即可，不用其它依赖。springboot的配置文件和启动类不用做任何特殊配置，使用knife4j需要一个swagger的配置类，这个配置类和以前使用swagger几乎是一样的：

@Configuration
@EnableSwagger2
@EnableSwaggerBootstrapUi
public class Swagger2Config {
    @Bean
    public Docket createRestApi() {
        return  new Docket(DocumentationType.SWAGGER_2)
                .useDefaultResponseMessages(false)
                .apiInfo(apiInfo())
                .select()
                .apis(RequestHandlerSelectors.basePackage("spring.boot.knife4j.controller"))
                .paths(PathSelectors.any())
                .build();
 
    }
 
    private ApiInfo apiInfo() {
        return new ApiInfoBuilder()
                .title("项目接口文档")
                .description("服务相关接口")
                .contact(new Contact("vincent",null,"vincent549@vip.qq.com"))
                .version("1.0")
                .build();
    }
 
}

可以看到，内容上没什么变化，唯一的变化是类注解需要比原来的swagger多加一个 @EnableSwaggerBootstrapUi。这样knife4j的所有配置都完成了，启动项目可以访问地址：

http://localhost:8080/doc.html?plus=1

来看一下效果：

接口配置

下面来配置一个简单的接口，查看文档的展示效果。

首先来看接口的通用返回结果：

@ApiModel("通用接口返回对象")
@AllArgsConstructor
@NoArgsConstructor
@Data
public class Results<T> {
 
    @ApiModelProperty(required = true,notes = "结果码",example = "200")
    private int state;
    @ApiModelProperty(required = true,notes = "时间戳",example = "1567425139000")
    private long time;
    @ApiModelProperty(required = true,notes = "返回信息",example = "SUCCESS")
    private String message;
    @ApiModelProperty(required = true,notes = "返回数据",example = "{\"name\":\"blues\"}")
    private T content;
 
}

@ApiModel("用户对象")
@AllArgsConstructor
@NoArgsConstructor
@Data
public class UserVO {
 
    @ApiModelProperty(required = true,notes = "用户名",example = "blues")
    private String name;
 
    @ApiModelProperty(required = true,notes = "用户返回消息",example = "hello world")
    private String words;
 
  
}

通过上面两个的定义，接口的返回类型就搞定了，下面来看接口：

@Api(tags = "HELLO CONTROLLER 测试功能接口")
@RestController
public class HelloController {
 
 
    @ApiImplicitParams({
            @ApiImplicitParam(name = "name",value = "用户名称",required = true,dataType = "String",paramType = "path",example = "blues")
    })
    @ApiResponses(value = {
            @ApiResponse(code = 200, message = "接口返回成功状态"),
            @ApiResponse(code = 500, message = "接口返回未知错误，请联系开发人员调试")
    })
    @ApiOperation(value = "Hello 测试接口", notes = "访问此接口，返回hello语句，测试接口")
    @GetMapping("hello/{name}")
    public Results<UserVO> hello(@PathVariable String name){
        UserVO userVO = new UserVO(name,"hello " + name);
        Results<UserVO> results = new Results<>(200,"SUCCESS", userVO);
        return results;
    }
 
}

这个接口类中分为几个部分需要注意，第一是类上面的@Api注解，描述了整个类的接口分类含义。还有一个是每个接口上面的 @ApiImplicitParams 注解，定义了接口的所有参数。还有@ApiResponses注解，定义了返回时，所有状态码所代表的的含义，最后是@ApiOperation注解，描述了单个接口本身的功能。

定义接口完成后，我们来重启项目，查看文档的效果：