接口文档编写方法，以showDoc为例

今夕 388 2023-11-08


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

互联网开发，经常会遇到写接口文档的情况，showdoc作为一款专业API接口编写工具，虽然是web端工具，但非常好用，兼容性很好。小编在本篇简单介绍下showdoc的基本使用。

步骤

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

image.png

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

image.png

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

image.png

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

image.png

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

image.png

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

image.png

7.showdoc且有如下较多亮点

①支持markdown语法（所有的api接口写作现在都支持这个吧，因为他现在太方便了）

②支持多用户协作，你可以在项目下面随意添加多个用户一起完成api文档的写作。

③可以分享并导出项目，生成需要的文档格式如doc，可以离线浏览

④支持响应式，手机电脑同样精彩

⑤支持项目转让

⑥支持模版插入

⑦支持历史版本，你可以把操作恢复到以前的版本。

⑧showdoc完全开源

⑨可以部署到自己的服务器

⑩如果在线使用，可以设置自己的个性域名，也可以对文档进行加密，浏览者需要密码才能访问

⑩可以通过一个在线测试api的工具，直接生成markdown，你几乎不用写代码就能过所有的参数自动生成

image.png



API接口文档ShowDoc编写软件如何添加二级目录

互联网开发，经常会遇到写接口文档的情况，showdoc作为一款专业API接口编写工具，虽然是web端工具，但非常好用，兼容性很好。小编在本篇简单介绍下showdoc使用中建立二级目录的方法。

image.png

步骤

1.登录Showdoc,如无相关帐号，请及时注册。避免忘记密码资料丢失，建议绑定邮箱

image.png

2.登录成功后，展陵趴示的是项目列表，默认有3个实例供参考，新建一个项目柱速

image.png

image.png

3.新建成功后会返回刚才的列表，点击进入该项目。

image.png

4.新建的项目刚进来是空白的，左侧是接口列表名称。右侧为对应选中接口的详细内容。点击文件夹符号，管理目录。

image.png

5.默认展示目录列表，此处我们来新建一级目录，输入目录名称，补充序号（用于左侧借口列表排序）后确认。

image.pngimage.png

6.同样步骤添加二级目录，但一定要选择上级目录。这样添加成功后就会成功绑定上下陕恩杰级关系。

image.png

注意事项

同样，多级目录也是支持的




版权声明：本文内容由网络用户投稿，版权归原作者所有，本站不拥有其著作权，亦不承担相应法律责任。如果您发现本站中有涉嫌抄袭或描述失实的内容，请联系我们jiasou666@gmail.com 处理，核实后本网站将在24小时内删除侵权内容。

标签：接口文档 接口文档编写 接口 方法 文档
上一篇: “自动化接口测试用例例子：让您轻松提升测试效率的完美解决方案”
下一篇:组装测试和接口测试 - 优化您的软件开发流程
相关文章

 发表评论

暂时没有评论，来抢沙发吧~