在项目开发过程中，web项目的前后端分离开发，APP开发，需要由前端后端工程师共同定义接口，编写接口文档，之后大家都根据这个接口文档进行开发。
什么是knife4j简单说knife4j就swagger的升级版API文档的一个框架,但是用起来比swagger方便多了，UI更加丰富。
界面欣赏 主页 接口文档 调试界面 参数实体 整合 knife4j 引入 maven 依赖 knife4j 配置文件创建 Knife4jConfig 文件
配置API接口通过 @Api注解标注需要生成接口文档，通过 @ApiOperation注解标注接口名。 同时我们给 SysDictType也加上对应的注解
通过 @ApiModel标注这是一个参数实体，通过 @ApiModelProperty标注字段说明。访问 http://localhost:8080/doc.html体验一下,出现访问资源异常
出现这个问题的原因是因为我们加上了 ResponseBodyAdvice统一处理返回值/响应体，导致给Swagger的返回值也包装了一层，UI页面无法解析。可以通过 http://localhost:8080/v2/api-docs?group=SwaggerDemo观察Swagger返回的json数据。
既然知道了问题原因那就很好解决了，我们只需要在ResponseBodyAdvice处理类中只转换我们自己项目的接口即可。
详细的可以参考SpringBoot 如何统一后端返回格式。通过添加basePackage属性限定统一返回值的范围，这样就不影Swagger了 ，重启服务器再次访问swagger接口地址，就可以看到接口文档页面了。
knife4j 常用特性knife4j 在 swagger 的基础上做了许多增强，这里介绍几个最常用的。使用增强特性需在application.yml 中开启 。
全局参数前后端分离开发中一般使用 token 作为请求参数进行身份与权限鉴定，有放在 query（表单）和 header（请求头）的，knife4j 对这两种都进行了支持，只需在侧边栏‘文档管理 -> 全局参数设置’中设置。
离线文档有时我们需要一份离线文档可以随时随地进行查看，knife4j 支持导出四种格式（ md、html、doc 、json）的离线文档，在侧边栏‘文档管理 -> 离线文档’中导出。
到此这篇关于Springboot中整合knife4j接口文档的文章就介绍到这了,更多相关Springboot整合knife4内容请搜索七叶笔记以前的文章或继续浏览下面的相关文章希望大家以后多多支持七叶笔记！
