您的位置:首页 > 其它

一个非常适合IT团队的在线API文档、技术文档工具

2020-03-09 22:28 441 查看

独乐乐,不如众乐乐.

之前单独写过一篇文章《介绍几款常用的在线 API 管理工具》,今天又发现个不错的工具,推荐给大家。

ShowDoc

每当接手一个别人开发好的模块或者项目,看着那些没有写注释的代码,文档呢?!文档呢?!Show me the doc !!你很希望别人能写技术文档,而自己却很不希望要写文档。即使有文档,也是零零散散地放在团队不同人手里,到硬盘里搜一波,用 QQ 、邮箱直接丢,这种沟通当然可以,只是效率不高。ShowDoc 是款适合 IT 团队的在线文档分享工具,可以让团队之间更高效的沟通。 题图 from pixabay

API 在线文档

APP、web 、Iot设备等前端与服务器常用 API 来进行交互.方便快速地编写出美观的 API 文档,支持 MarkDown 语法.

数据结构、基础字典

好的数据字典可以很方便地向别人描述你的数据库结构.用 ShowDoc 可以编辑出美观的数据字典.

支持二次开发

工具是基于PHP+VUE的方式完成,可以根据需要进行定制化开发.

权限控制、团队协作

团队权限管理机制让团队良好地协同编写文档.

关键是:免费的开源的

ShowDoc 提供免费开源的版本.

你可以选择将 ShowDoc 部署到你的服务器.

多种文档支持

你完全可以使用 ShowDoc 来编写一些工具的说明书.也可以编写一些技术规范说明文档以供团队查阅.

提供在线、私有部署两种方式

www.showdoc.cc 提供安全稳定的在线文档托管服务.你可以放心地选择托管你的文档数据在云端.

手机 App 支持

提供 iOS 与 Android 两个版本,提供私有部署版地址绑定。

在线测试 API

提供RunApi功能支持 post/get 常用的 http 请求方式,可以添加 URL 请求参数,也可以自定义 header.

上几张截图,看看效果:


我申请了一个知识星球,2020 年着手沉淀一些内容,内容聚焦于个人思考、阅读、写作、投资理财、技术提升等,顺便你也可以在星球里提问,我会竭尽所能回复你,希望在未来为期一年的陪伴中,对你有所帮助。

  • 点赞
  • 收藏
  • 分享
  • 文章举报
Jerish_C 博客专家 发布了99 篇原创文章 · 获赞 808 · 访问量 79万+ 他的留言板 关注
内容来自用户分享和网络整理,不保证内容的准确性,如有侵权内容,可联系管理员处理 点击这里给我发消息
标签: