Knife4j，一个好用的自动生成接口文档工具

knife4j是本人用过的自动生成接口文档工具中最好用的，之前有用过JApiDocs和Swagger作为自动生成接口文档工具。但都没有knife4j的用得舒服。

1、下面是JApiDocs生成的接口文档，可以看到，虽然具备接口文档的用途，但相对于knife4j来说少了挺多东西的。

下面是knife4j生成的接口文档，对比起上面，页面好看了不少，而且功能也多了许多。

多了调试的功能，不用再去postman、apifox接口测试工具测试接口了

还可以通过四种方式下载到本地离线观看

2、接下来介绍如何使用knife4j

（1）引入knife4j的依赖

只需要引入这一个接口文档依赖就可以了，多引入可能会冲突。

<!--        接口文档--><dependency><groupId>com.github.xiaoymin</groupId><artifactId>knife4j-openapi2-spring-boot-starter</artifactId><version>4.1.0</version></dependency>

（2）在配置文件中开启knife4j

记得把这项配置放在配置文件的最后或较后面，否则可能会出现还没读到数据库配置就开始报错了。

#开启api文档
knife4j:enable: true

（3）在各代码层加上相应的注解

不同于JApiDocs是通过注释来生成备注，knife4j通过注解来生成备注

这里介绍一下主要的注解，其他注解可以参考官方文档。具体效果可以自己尝试。

//controller层的类前注解
@Api(tags = "用户接口")//controller层方法前注解和mapping无位置要求
@ApiOperation(value = "登录")
@PostMapping("/login")//dto层属性前注解，也是参数属性注解
@ApiParam(value = "员工ID",required = true) String id//model或vo层属性前注解
@ApiModelProperty(value = "日志id")

（4）然后启动项目

在浏览器中输入链接: http://localhost:端口号/doc.html，打开前可以确认一下会不会被拦截器拦截了，拦截了要放行才能看到。

官方文档：Knife4j · 集Swagger2及OpenAPI3为一体的增强解决方案. | Knife4j

Knife4j，一个好用的自动生成接口文档工具相关推荐

springboot 中文文档_比Swagger还好用的自动生成接口文档工具
JApiDocs是一个无需额外注解.开箱即用的SpringBoot接口文档生成工具. 编写和维护API文档这个事情,对于后端程序员来说,是一件恼人但又不得不做的事情,我们都不喜欢写文档,但除非项目前后 ...
springboot 之自动生成接口文档工具JApiDocs
JApiDocs是一个无需额外注解.开箱即用的SpringBoot接口文档生成工具简易使用方法 1.添加依赖 <dependency><groupId>io.github.y ...
java自动生成接口文档
java自动生成接口文档 maven依赖工具类展示效果首页接口页在平时的开发过程中必定要写接口文档作为程序员最烦的2件事 1.别人让你写接口文档 2.接手别人的项目没有接口文档由此可见 ...
Django框架深入了解_05 (Django中的缓存、Django解决跨域流程(非简单请求，简单请求)、自动生成接口文档)(二)
二.跨域: 回到顶部跨域知识介绍: 点我以前博客跨域解决方法:CORS:跨域资源共享 CORS请求分类(简单请求和非简单请求) 简单请求(simple request):只需要在头信息之中增加一个 ...
Django框架深入了解_05 (Django中的缓存、Django解决跨域流程(非简单请求，简单请求)、自动生成接口文档)(一)
阅读目录一.Django中的缓存: 前戏: Django中的几种缓存方式: Django中的缓存应用: 二.跨域: 跨域知识介绍: CORS请求分类(简单请求和非简单请求) 示例: 三.自动生成接口 ...
Spring Boot（九）Swagger2自动生成接口文档和Mock模拟数据
一.简介在当下这个前后端分离的技术趋势下,前端工程师过度依赖后端工程师的接口和数据,给开发带来了两大问题: 问题一.后端接口查看难:要怎么调用?参数怎么传递?有几个参数?参数都代表什么含义? 问题二 ...
idea swagger生成接口文档_Spring Boot（九）Swagger2自动生成接口文档和Mock模拟数据...
一.简介在当下这个前后端分离的技术趋势下,前端工程师过度依赖后端工程师的接口和数据,给开发带来了两大问题: 问题一.后端接口查看难:要怎么调用?参数怎么传递?有几个参数?参数都代表什么含义? 问题二 ...
SpringBoot自动生成接口文档
跟大家介绍一个自动生成接口文档的工具包,作者的理念是注释即文档,在写代码的时候写上注释,项目启动后就会生成接口文档,非常方便,省去了Swagger写注解的过程. 仓库地址:https://github ...
DRF 自动生成接口文档
Python微信订餐小程序课程视频 https://edu.csdn.net/course/detail/36074 Python实战量化交易理财系统 https://edu.csdn.net/cou ...
自动生成接口文档之JApiDocs教程
JApiDocs教程前言作为一名优秀的程序员来说,由于涉及到要与前端进行对接,所以避免不了的就是写接口文档.写完接口文档,一旦代码返回结果,参数等出现变动,接口文档还得随之改动,十分麻烦,违背了我 ...

Knife4j，一个好用的自动生成接口文档工具

knife4j是本人用过的自动生成接口文档工具中最好用的，之前有用过JApiDocs和Swagger作为自动生成接口文档工具。但都没有knife4j的用得舒服。

1、下面是JApiDocs生成的接口文档，可以看到，虽然具备接口文档的用途，但相对于knife4j来说少了挺多东西的。

下面是knife4j生成的接口文档，对比起上面，页面好看了不少，而且功能也多了许多。

多了调试的功能，不用再去postman、apifox接口测试工具测试接口了

还可以通过四种方式下载到本地离线观看

2、接下来介绍如何使用knife4j

（1）引入knife4j的依赖

（2）在配置文件中开启knife4j

（3）在各代码层加上相应的注解

（4）然后启动项目

Knife4j，一个好用的自动生成接口文档工具相关推荐

最新文章

热门文章

Knife4j，一个好用的自动生成接口文档工具

knife4j是本人用过的自动生成接口文档工具中最好用的，之前有用过JApiDocs和Swagger作为自动生成接口文档工具。但都没有knife4j的用得舒服。

1、下面是JApiDocs生成的接口文档，可以看到，虽然具备接口文档的用途，但相对于knife4j来说少了挺多东西的。

​

下面是knife4j生成的接口文档，对比起上面，页面好看了不少，而且功能也多了许多。

​

多了调试的功能，不用再去postman、apifox接口测试工具测试接口了

​

还可以通过四种方式下载到本地离线观看

​

2、 接下来介绍如何使用knife4j

（1）引入knife4j的依赖

（2）在配置文件中开启knife4j

（3）在各代码层加上相应的注解

（4）然后启动项目

Knife4j，一个好用的自动生成接口文档工具相关推荐

最新文章

热门文章

2、接下来介绍如何使用knife4j