如何给自己的项目实现在线测试的接口文档knife4j

配置实现Knife4j在线接口测试文档

为什么要是实现这个东西呢？肯定是对我们有用的，后端主要编写的就是接口，然后我们将接口编写好了之后肯定还是需要进行调试看是否能够正常使用且按照规范返回对应的数据。相信大家测试都是基本上使用的是一些应用程序进行接口测试的，这里我要给大家介绍一款能够在线测试的工具库，配置到yml文件中之后就能使用在线测试，而不需要再单开一个应用来进行接口测试。

这里可以给大家贴一个官网的地址感兴趣的可以自己去了解一下 Knife4j官方文档地址

1. 配置流程

   • 引入Knife4j依赖到你的项目中
   • 到yml文件中对Knife4j进行配置
   • 启动项目登录网址使用

2. 具体实现

   1. 引入Knife4j依赖

      <!-- https://doc.xiaominfo.com/docs/quick-start#openapi2 -->
      <dependency><groupId>com.github.xiaoymin</groupId><artifactId>knife4j-openapi2-spring-boot-starter</artifactId><version>4.4.0</version>
      </dependency>
      

   2. 配置yml

      # 接口文档配置
      knife4j:enable: trueopenapi:title: "接口文档"version: 1.0group:default:api-rule: packageapi-rule-resources:- com.way.review_oj.controller   # 这里的controller文件地址改为你自己的
      

   3. 启动项目

      

      如果你的项目启动之后显示的上面的这种效果，那么就是成功的

   4. 输入网址进行查看

      

总结：

​ 通过这个工具类能够快速的帮助我们实现在线接口文档的测试，当然我这里只使用了它最基本的配置，因为我觉得对于我来说够用了，它可以通过注解等生成更加详细的在线接口文档，有兴趣的可以自己去探索一下。