showdoc icon indicating copy to clipboard operation
showdoc copied to clipboard

请问使用runapi管理文档 文档防止误删和操作历史相关有的吗

Open wongjull opened this issue 3 years ago • 2 comments

首先特别感谢作者的开源,showdoc使用了3年多了;一路走来看着慢慢完善 功能也越来越强大,也祝愿showdoc越来越好。

#请问使用runapi管理文档 文档防止误删和操作历史相关有的吗 团队开始试用runapi 多人协作生成文档,同事提出一个疑问,如果其中一个人修改了接口文档 这个有记录历史吗?如果别人误删了别人的目录这个是可以恢复吗?

暂时考虑到的方案(脚本自动生成和runapi结合的方式): 1.接口设计时使用showdoc_api.sh脚本扫描 注解的方式生成目录和接口结构;(但发现回显到runapi时入参和响应参数暂时无回显) 2.然后借用runapi 来更新最新的参数和响应内容,方便测试人员使用测试用例;

以上方式是可以一定程度避免,误删目录导致的问题;但runapi修改后无记录的问题好像还是没有解决,请问有更好实现方案吗?

wongjull avatar Jul 18 '22 09:07 wongjull

我记得前段时间的新版解决了showdoc_api.sh脚本不能回显的问题,你先更新新版看看

star7th avatar Jul 19 '22 02:07 star7th

以后runapi考虑出一个只读成员角色,这样就不能乱删除了。至于历史版本记录,得考虑看情况。

star7th avatar Jul 19 '22 02:07 star7th