放弃丑陋的 swagger-ui,使用 knife 接口文档生成神器


knife Gitee 地址:https://gitee.com/xiaoym/knife4j

接口生成利器 knife 介绍

之前项目中一直在使用 swagger 生成后台接口文档,很好用,至少比之前用 word 写接口文档 postman 调试接口方便多了。swagger 提供了一套前端页面,但是需要在代码中加入注解,如: @Api @ApiOperation 等,耦合度比较高,但使用起来很方便。对我强迫症的我来说,swagger-ui 页面奇丑无比,给我的感觉就是特别乱,并且没办法保存常用的参数,使用起来很不方便。

这篇文章来介绍 knife,是 swagger 的增强版。该UI增强包主要包括两大核心功能:文档说明在线调试

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

功能不过多介绍,直接上图演示:

springboot 整合 knife

springboot 基本框架搭建就不过多介绍了,直接演示 springboot 整合 knife 需要改动的配置。

pom.xml 文件增加依赖

由于是 springfox-swagger 的增强UI包,所以基础功能依然依赖 swaggerspringfox-swagger 的 jar 包必须引入。然后引入 knife4j-spring-ui 替代原来的 swagger-ui

<dependency>
  <groupId>io.springfox</groupId>
  <artifactId>springfox-swagger2</artifactId>
  <version>
  • 3
    点赞
  • 8
    收藏
    觉得还不错? 一键收藏
  • 0
    评论
Swagger-UI在线接口文档的优点包括以下几个方面: 1. 支持接口文档导出:Swagger-UI可以将接口文档以PDF、Word和Markdown等格式导出,方便开发者进行离线查阅和分享。[2] 2. 多种方式使用Swagger-UI可以与其他工具同时使用,比如springfox-swagger-ui,可以根据项目需求选择最适合的方式。[2] 3. 友好的界面:相比于springfox-swagger-uiSwagger-UI的界面更加友好,排版结构更加清晰,使得接口文档更易于理解和使用。[2] 4. 搜索功能:Swagger-UI支持接口内容的搜索,可以快速定位到需要查找的接口,提高了开发效率。[2] 5. 接口版本管理:Swagger-UI可以对接口进行版本管理,方便开发者对接口进行更新和维护。[2] 6. 国际化支持:Swagger-UI支持多语言界面,可以根据用户的语言偏好进行界面显示。[2] 7. 自定义文档:Swagger-UI支持开发者对接口文档进行自定义,可以根据项目需求添加额外的信息和说明。[2] 8. 生产环境屏蔽:Swagger-UI支持在生产环境中屏蔽Swagger的所有资源接口,保护接口文档的安全性。[2] 9. 接口权限控制:Swagger-UI可以设置在线接口文档的权限控制,限制不同用户对接口文档的访问权限。[2] 综上所述,Swagger-UI在线接口文档具有导出、多种使用方式、友好界面、搜索功能、版本管理、国际化支持、自定义文档、生产环境屏蔽和权限控制等优点。
评论
添加红包

请填写红包祝福语或标题

红包个数最小为10个

红包金额最低5元

当前余额3.43前往充值 >
需支付:10.00
成就一亿技术人!
领取后你会自动成为博主和红包主的粉丝 规则
hope_wisdom
发出的红包
实付
使用余额支付
点击重新获取
扫码支付
钱包余额 0

抵扣说明:

1.余额是钱包充值的虚拟货币,按照1:1的比例进行支付金额的抵扣。
2.余额无法直接购买下载,可以购买VIP、付费专栏及课程。

余额充值