最近我们产品的api变化挺大的,这时候去修改文档就是一个很麻烦的事情。因为有的序列化的工具是通用的,修改一个地方会影响到很多地方,这样要不就是去手动的一个个的改,要不就是忽略不管了。
当然了,实际情况就是只修改了重要的地方,有一些就忽略掉了。我们写文档使用的是confluence,这个其实更侧重于通用的内容分享,而不是写代码文档,所以每次还要自己手动的画表格,然后写url写测试数据和响应数据,太麻烦了。于是下面这个工具就诞生了。
这个工具你要是手动的写上url,测试数据,方法等就能获取到服务器响应,自动的填充,只要点击保存就可以了。
左侧是一个树状的分类,默认是全部展开的。点击分类文件夹在右边展示该文件夹下面所有的api,默认折叠显示,点击可以展开。点击单个的api,可以独立的查看。api和分类都可以编辑删除和修改父节点。
其实这个工具还是一个优点就是可以自动的去更新数据,不过这个功能还没去写。因为有了测试的url和数据了啊。
**粗体** _斜体_ [链接](http://example.com) `代码` - 列表 > 引用
。你还可以使用@
来通知其他用户。