| |
|
开发:
C++知识库
Java知识库
JavaScript
Python
PHP知识库
人工智能
区块链
大数据
移动开发
嵌入式
开发工具
数据结构与算法
开发测试
游戏开发
网络协议
系统运维
教程: HTML教程 CSS教程 JavaScript教程 Go语言教程 JQuery教程 VUE教程 VUE3教程 Bootstrap教程 SQL数据库教程 C语言教程 C++教程 Java教程 Python教程 Python3教程 C#教程 数码: 电脑 笔记本 显卡 显示器 固态硬盘 硬盘 耳机 手机 iphone vivo oppo 小米 华为 单反 装机 图拉丁 |
-> 开发测试 -> API文档工具 -> 正文阅读 |
|
[开发测试]API文档工具 |
SwaggerSwagger是一款非常流行的API文档工具,它能帮助你简化API文档的开发,极大提高开发效率,之前在 我们一般将Swagger和SpringBoot结合使用,使用的是Springfox给我们提供的工具。使用该工具可以根据注解自动生成API文档,并且可以在生成的文档上进行接口调试。 由于API文档随着项目的启动而更新,所以API文档的实时性很有保证!Springfox官方还给我们提供了Starter,整合非常方便,如果你还在SpringBoot项目中手动整合Swagger的话,不妨看下《还在手动整合Swagger?Swagger官方Starter是真的香!》?。 项目地址:https://github.com/springfox/springfox Knife4j虽然Swagger已经非常好用,但是存在界面不够美观,API调试功能弱的缺点,比如请求参数没有校验,返回一堆JSON数据时无法折叠这类问题。于是在Swagger的基础上,就有了一些增强工具的出现。 Knife4j是springfox-swagger的增强UI实现,为Java开发者在使用Swagger的时候,提供了简洁、强大的接口文档体验。Knife4j完全遵循了springfox-swagger中的使用方式,并在此基础上做了增强功能,如果你用过Swagger,你就可以无缝切换到Knife4j。 使用Knife4j就好像给Swagger换了个新皮肤,瞬间就高大上了,具体使用可以参考《给Swagger换了个新皮肤,瞬间高大上了!》?。 如果你的项目是微服务项目的话,使用Knife4j可以聚合所有服务的文档,具体使用可以参考《微服务聚合Swagger文档,这波操作是真的香!》?。 项目地址:https://github.com/xiaoymin/swagger-bootstrap-ui Postman由于Swagger的接口调试能力比较弱,使用Postman来调试也不失为一个好方案。 Postman是一款API接口调试工具,使用它可以很方便的对接口进行测试,并且后端人员可以将自己的调试结果导出,方便前端人员调试,具体使用可以参考《Postman:API接口调试利器》?。 当然在Postman中查看API文档也是可以的,只是功能有点偏弱,所以才有了Swagger+Postman这种流行组合,具体可以参考《Swagger界面丑、功能弱怎么破?用Postman增强下就给力了!》?。 官方网站:https://www.postman.com/ YApi除了Knife4j这类给Swagger做增强的工具,还有一类工具本身就具有API文档管理的功能,可独立部署并且可以对接Swagger,功能更加强大,也可以称之为API文档管理平台。 YApi正是这样一种工具,YApi是高效、易用、功能强大的API管理平台,旨在为开发、产品、测试人员提供更优雅的接口管理服务。YApi在Github上已累计获得了18K+Star,具有优秀的交互体验,YApi不仅提供了常用的接口管理功能,还提供了权限管理、Mock数据、Swagger数据导入等功能,总之功能很强大! YApi的具体使用可以参考《当Swagger遇上YApi,瞬间高大上了!》?。 项目地址:https://github.com/YMFE/yapi smart-docSwagger需要通过它自己的注解来实现API文档的生成,代码入侵性有点强,如果你想零入侵的话,不妨试试
项目地址:https://gitee.com/smart-doc-team/smart-doc Torna又一款可独立部署的API文档管理工具,可以搭建API文档管理平台。不仅支持Swagger导入、还支持Postman和OpenApi等导入。 Torna是一套企业级接口文档解决方案,可以配合Swagger使用,具体参考《当 Swagger 遇上 Torna,瞬间高大上了!》?。它具有如下功能:
项目地址:https://gitee.com/durcframework/torna Apifox一款在线使用的API文档管理工具,可以配合Swagger使用,功能强大,界面炫酷! Apifox 的定位是 具体使用可以参考:《取代 Postman + Swagger!这款神器功能更强大,界面更炫酷!》?。 官方网站:https://www.apifox.cn/ 总结本文整理了之前使用过的7种API文档生成+管理工具,如果你是刚开始使用API文档工具的话,使用Swagger准没错!如果你正在使用Swagger,想要使用更好的API文档工具的话,可以考虑将Swagger配合Knife4j、YApi或Torna来使用。如果你不介意在线使用API文档管理工具的话,可以使用Apifox,它的功能更强大。 最后,大家用的哪种API文档工具呢? 转载:公众号?macrozheng |
|
开发测试 最新文章 |
pytest系列——allure之生成测试报告(Wind |
某大厂软件测试岗一面笔试题+二面问答题面试 |
iperf 学习笔记 |
关于Python中使用selenium八大定位方法 |
【软件测试】为什么提升不了?8年测试总结再 |
软件测试复习 |
PHP笔记-Smarty模板引擎的使用 |
C++Test使用入门 |
【Java】单元测试 |
Net core 3.x 获取客户端地址 |
|
上一篇文章 下一篇文章 查看所有文章 |
|
开发:
C++知识库
Java知识库
JavaScript
Python
PHP知识库
人工智能
区块链
大数据
移动开发
嵌入式
开发工具
数据结构与算法
开发测试
游戏开发
网络协议
系统运维
教程: HTML教程 CSS教程 JavaScript教程 Go语言教程 JQuery教程 VUE教程 VUE3教程 Bootstrap教程 SQL数据库教程 C语言教程 C++教程 Java教程 Python教程 Python3教程 C#教程 数码: 电脑 笔记本 显卡 显示器 固态硬盘 硬盘 耳机 手机 iphone vivo oppo 小米 华为 单反 装机 图拉丁 |
360图书馆 购物 三丰科技 阅读网 日历 万年历 2024年11日历 | -2024/11/18 6:42:15- |
|
网站联系: qq:121756557 email:121756557@qq.com IT数码 |