如何写接口文档，教你showDoc的基本使用方法

1、百度搜索“showdoc”,该站主打“一个非常适合IT团队的在线API文档、技术文档工具。你可以使用Showdoc来编写在线API文档、技术文档、数据字典、在线手册”。

2、首页是该工具亮点的banner图滚动，简单却突出了该工具特点。

3、首先编写API接口的人员需要注册一个账号，便于不同设备的同步管理。

4、登录成功后，首先展示的是各项目列表，如果未创建过项目，官方也给出了基本实例

5、实例文档如下，左侧是目录（支持多级目录），右侧主区域为左侧所选的接口实际内容，默认展示第一条。

6、一个基础的接口示例，让人很容易理解并操作。接口文档使用人员需要的时候，只需要将地址栏链接复制即可，不登录的情况下是无法做修改的。

7、showdoc且有如下较多亮点1：支持markdown语法（所有的api接口写作现在都支持这个吧，因为他现在太方便了）2：支持多用户协作，你可以在项目下面随意添加多个用户一起完成api文档的写作。3：可以分享并导出项目，生成需要的文档格式如doc，可以离线浏览4：支持响应式，手机电脑同样精彩5：支持项目转让6：支持模版插入7：支持历史版本，你可以把操作恢复到以前的版本。8：showdoc完全开源9：可以部署到自己的服务器10：如果在线使用，可以设置自己的个性域名，也可以对文档进行加密，浏览者需要密码才能访问11：可以通过一个在线测试api的工具，直接生成markdown，你几乎不用写代码就能过所有的参数自动生成