在线文档

# 在线文档

在 API 开发、沟通、协作中,逻辑上是以 API 文档为标准的,但实际操作中,存在以 Word、PDF 格式的文件传来传去的问题。为此我们提倡以在线文档的形式,提高团队之间的沟通效率

# 分享在线文档

在软件界面左侧,就可以设置当前项目的在线文档

点击新建分享,就可以根据需要,设置分享的信息内容:

  1. 访问密码

  2. 分享在线文档的日期

  3. 分享范围:可以选择项目全部,也可以选择部分接口,也可以根据标签维度导入

整目录分享

在线文档支持整目录分享功能,选择对应的分组打开整目录分享,则该分组在修改后会自动同步到在线文档。当然如果您不希望在线文档实时同步您的修改,可以选择不开启。

  1. 可以选择运行的环境,和显示对应的前置 URL

  2. 可以显示接口文档对应的责任人、修改时间

设置完成后,复制链接,就可以分享给团队成员了

# 查看在线文档

在线文档查看过程中,支持复制接口 URL、数据接口字段、返回示例字段