接口文档管理工具showDoc

随着互联网的发展，前后端分离已成为互联网项目开发的业界标准使用方式。

由此而产生的前端开发工程师和后端开发工程师的沟通效率问题。

推荐一个应此而生的文档管理工具---showdoc

showdoc官网

一、介绍

1.ShowDoc是什么

• 每当接手一个他人开发好的模块或者项目，看着那些没有写注释的代码，我们都无比抓狂。文档呢？！文档呢？！Show me the doc ！！

• 程序员都很希望别人能写技术文档，而自己却很不希望要写文档。因为写文档需要花大量的时间去处理格式排版，想着新建的word文档放在哪个目录等各种非技术细节。

• word文档零零散散地放在团队不同人那里，需要文档的人基本靠吼，吼一声然后上qq或者邮箱接收对方丢过来的文档。这种沟通方式当然可以，只是效率不高。

• ShowDoc就是一个非常适合IT团队的在线文档分享工具，它可以加快团队之间沟通的效率。

2.功能

• 权限管理

  • 公开项目与私密项目
    • ShowDoc上的项目有公开项目和私密项目两种。公开项目可供任何登录与非登录的用户访问，而私密项目则需要输入密码验证访问。密码由项目创建者设置。
  • 项目转让
    • 项目创建者可以*地把项目转让给网站的其他用户。
  • 项目成员
    • 你可以很方便地为ShowDoc的项目添加、删除项目成员。项目成员可以对项目进行编辑，但不可转让或删除项目（只有项目创建者才有权限）
  • 团队管理
    • 利用showdoc的团队功能你可以更好地进行团队协作

• 编辑功能

  • markdown编辑

    • ShowDoc采用markdown编辑器，无论是编辑还是阅读体验都极佳很棒。如果你不了解Markdown，请在搜索引擎搜索”认识与入门 Markdown”

  • 模板插入

    • 在ShowDoc的编辑页面，点击编辑器上方的按钮可方便地插入API接口模板和数据字典模板。插入模板后，剩下的就是改动数据了，省去了很多编辑的力气。
  • 历史版本
    • ShowDoc为页面提供历史版本功能，你可以方便地把页面恢复到之前的版本。

• 多平台

  showdoc支持网页版、手机app版和电脑客户端版。客户端地址可见：https://www.showdoc.cc/clients

二、示例

1.全局错误码

2.接口文档

3.api模板

4.接口调试