资讯专栏INFORMATION COLUMN

写了一个生成api文档的小工具

UsherChen / 2277人阅读

摘要:最近我们产品的变化挺大的,这时候去修改文档就是一个很麻烦的事情。于是下面这个工具就诞生了。左侧是一个树状的分类,默认是全部展开的。

最近我们产品的api变化挺大的,这时候去修改文档就是一个很麻烦的事情。因为有的序列化的工具是通用的,修改一个地方会影响到很多地方,这样要不就是去手动的一个个的改,要不就是忽略不管了。

当然了,实际情况就是只修改了重要的地方,有一些就忽略掉了。我们写文档使用的是confluence,这个其实更侧重于通用的内容分享,而不是写代码文档,所以每次还要自己手动的画表格,然后写url写测试数据和响应数据,太麻烦了。于是下面这个工具就诞生了。


这个工具你要是手动的写上url,测试数据,方法等就能获取到服务器响应,自动的填充,只要点击保存就可以了。

左侧是一个树状的分类,默认是全部展开的。点击分类文件夹在右边展示该文件夹下面所有的api,默认折叠显示,点击可以展开。点击单个的api,可以独立的查看。api和分类都可以编辑删除和修改父节点。

其实这个工具还是一个优点就是可以自动的去更新数据,不过这个功能还没去写。因为有了测试的url和数据了啊。

文章版权归作者所有,未经允许请勿转载,若此文章存在违规行为,您可以联系管理员删除。

转载请注明本文地址:https://www.ucloud.cn/yun/37437.html

相关文章

  • 分享一下这两周爬微信支付的坑~希望有借鉴作用(PHP)

    摘要:这个坑就是要注意回调结束要返回成功的响应这几天做微信支付暂时遇到的问题就这么多,只能说注意细节吧,爬过的坑记录下来以后遇到就懂处理了。 前言 其实任何接口开发只要按照给出来的接口文档和例子开发基本上不会有太大问题的,一些问题都是出在杂七杂八的小细节上,现在分享一下微信支付开发中自己遇到的小细节。按照文档做完开发前配置,比如JS安全域名配置、网页授权域名、公众号授权目录等等... 坑一:...

    Tangpj 评论0 收藏0
  • node.js初体验之利用node.js的fs-文件系统,来写一个批量修改文件名的小工具

    摘要:导语公司最近业务不忙,利用闲暇时间准备学习一下,看见网上前端大牛张旭鑫的文章一般般的网页重构可以使用做些什么,跟着写了一下批量修改文件名的小工具,主要利用的中相关方法来实现记录一下,以备后用。 导语:公司最近业务不忙,利用闲暇时间准备学习一下Node.js,看见网上前端大牛张旭鑫的文章JS一般般的网页重构可以使用Node.js做些什么?,跟着写了一下批量修改文件名的javascript...

    Steve_Wang_ 评论0 收藏0
  • 【轻松集赞】写了个涉嫌混淆微信官方服务的小程序

    摘要:吃饱喝足,两个人扶着腰走在路上炫腹还是女盆友的提醒说,你不是会小程序吗,能不能写一个点赞的小程序来用。哎还真是,我自己撸一个也是阔以的,说不定还能给其他人用。比较适合想要练手小程序和的童鞋全部的代码还请移步我的欢迎和。 showImg(https://segmentfault.com/img/remote/1460000015245489?w=530&h=153); 发生背景:    ...

    xiao7cn 评论0 收藏0
  • 2017回顾

    摘要:按使用的语言来总结一下年。第三个后端项目,还算比较成功,上线了大半年,没有明显的性能问题,做修改也是非常容易。还用了一个集群去做部署先是阿里云的集群方案,后是,集群监控日志采集配置管理等等都没少弄。 showImg(https://segmentfault.com/img/bV0VHw?w=1495&h=1144); 按使用的语言来总结一下2017年。 TypeScript 用Type...

    springDevBird 评论0 收藏0
  • 我去!又是勇士和骑士?--NBA资讯小程序

    摘要:话不多说,先来一张我科的图坐镇资讯小程序出来啦作为一个刚接触小程序不久的前端小白菜,恰逢最近如火如荼的双抢七大战骑士与勇士又又又又又一次的巅峰对决实话真的看腻了决定写一个资讯的小程序来玩玩。 showImg(https://segmentfault.com/img/remote/1460000015202389?w=580&h=580);话不多说,先来一张我科的图坐镇 NBA资讯小程序...

    DesGemini 评论0 收藏0

发表评论

0条评论

最新活动
阅读需要支付1元查看
<