java 接口文档的格式化_写word格式接口文档太繁琐?试试新的工具?

在对接项目接口的时候,时不时会碰到要word格式接口文档的需求,特别是做外包的时候,不仅要求清晰,还要做得美观。想过格式,每个接口参数、请求方式、响应都需要自己去一个一个粘贴,有时候一个项目功能复杂点,接口特别多,几百个接口要整理两三天,比敲代码还累。

我就在想有没有工具能满足开发过程中的测试需求,还能随时导出各种格式的接口文档,甚至在我开发的时候自动生成接口文档,前端也能看到。 我原先一直使用的是postman,支持生成接口文档,还能测试接口,但是英文版的看的比较费劲,导出来的word文档看着也一样费劲。

于是我在各种论坛上找,开源的商用的都看了,发现要么是单纯测试接口的工具,要么就是操作使用特别复杂的,不能满足我的需求。 最后还是在某个技术交流群里,被人推荐了一个叫Eolinker的国产接口管理工具,说是能满足我的需求,还是Saas服务,可以直接在网站上用,就去试了一下。

注册,创建工作空间,顺手试了一下接口测试的功能,没有发现明显的bug,界面也挺简洁,不过重点还是看它导出的文档怎么样。

5cc27b6d124971c5af2055548a5eea13.png

在项目里点击要导出的接口, 选中就可以单个/批量导出接口,初始未选中任何数据是禁用状态的;

17eb4d0004c23eb281a6666637c48761.png

80d06b15af91f208fd42ac875604ed8a.png

点击导出后,发现不止能导出word格式,还有json、excel、PDF以及Markdown的格式也能导。

ac35cb445050e577b59136ba040eeb82.png

最后就可以直接点开word文档了,来看看效果怎么样。

0ab48c682aadfb7c01e04eb1589e7b56.png

6681c754f347821d4a1ef87e680d7c46.png

61e43e39a07e53fee18c76b6ab673949.png

这样看起来还挺清晰美观的,多个接口也不用很麻烦的去合并文档,可以省下来好多时间哈哈。 具体的推荐自己去试试,说不定你也觉得顺手呢,随时欢迎用过的朋友找我交流~ 使用地址:www.eolinker.com

  • 0
    点赞
  • 2
    收藏
    觉得还不错? 一键收藏
  • 0
    评论
评论
添加红包

请填写红包祝福语或标题

红包个数最小为10个

红包金额最低5元

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

抵扣说明:

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

余额充值