Show-Doc让你能在公司装一波的接口文档搭建全流程

大家还记得之前阿宇给大家推荐的一个写接口文档的神器么?Run-API,前段时间,因为 Show-Doc 进行网站升级,忽然的一天早上 Run-API 失效了,这下整的阿粉就有崩溃了,啥情况,和阿粉对接的前端也有点懵逼,说接口文档忽然访问不了了,阿粉于是赶紧查看,原来是因为阿粉的接口,是完全的依托于 Show-Doc 的服务器进行了发布,为了防止这种情况的出现,阿粉就开始研究关于 Show-Doc 如何在自己的电脑行搭建一个服务,这样如果 Show-Doc 网站再次升级的时候,也就不会出现这么悲剧的事情了。

关于 Show-Doc

ShowDoc 是一个非常适合 IT 团队的在线文档分享工具,它可以加快团队之间沟通的效率,为什么这么说,因为目前现在很多公司都是建立的前后端分离的项目,很多后端都是专职后台业务逻辑的开发,这时候就会出现,每个人写文档的风格不一致,有些人使用 Excel 有些人使用 Word 表格,有些人使用 Swagger 还有人使用 Show-Doc。

而且尤其是在有新老员工离职交接的时候,交接的接口文档都交接不明白,因为很多都是接口写完了,发给前端,功能上线后,文档没用都删除了,这个时候就得去看代码上面的注释,有注释的还好说,没有注释的,那就让你疯狂的崩溃。不知道代码谁写的,这样岂不是很尴尬,这时候我们就可以在公司内部搭建一个文档类型的服务器,好处有很多呀,比如:

  • 一边调试接口、一边自动生成文档
  • 分配项目成员和团队成员,你可以很方便地进行项目文档的权限管理和团队协作
  • 支持多平台客户端,有win客户端、
  • 1
    点赞
  • 3
    收藏
    觉得还不错? 一键收藏
  • 1
    评论

“相关推荐”对你有帮助么?

  • 非常没帮助
  • 没帮助
  • 一般
  • 有帮助
  • 非常有帮助
提交
评论 1
添加红包

请填写红包祝福语或标题

红包个数最小为10个

红包金额最低5元

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

抵扣说明:

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

余额充值