在线分享

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

    在线分享 - 图2

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

    • 文档语言
    • 访问密码
    • 分享在线文档的日期
    • 分享范围:可以选择项目全部,也可以选择部分接口,也可以根据标签维度导入
    • 可以显示接口文档对应的责任人、修改时间、前置 URL

    整目录分享

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

    在线分享 - 图4

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

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

    前提条件:当设置 时,需要设置环境(推荐选择 云端 Mock

    在线分享 - 图7

    不仅在线文档支持在线运行调试,API Hub 中众多开放文档也支持,方便大家进行调试并使用,开发与对接效率再上一层。

    在线分享 - 图9 在线分享 - 图11

    前提条件:当设置 在线分享 时,需要设置接口引用了 的环境

    在线文档调试接口时,会存在修改接口文档引用的 环境变量 的场景,现在可以根据下图,修改 环境变量 并运行调试

    在线分享 - 图13

    分享出去的 在线接口文档 支持显示示例代码,当然 API Hub 也是支持的。您可以直接复制当前接口的代码,直接使用。

    使用方式:添加URL参数 即可,示例:

    WEB 版项目:

    在线文档:

    功能:设置“运行”模块的“接口参数”(仅支持项目内指定接口地址-运行Tab的情况)

    1. 简单模式

    注意:“简单模式”不支持参数名包含中括号的场景,这种场景请使用“高级模式”

    WEB 运行界面,通过URL传递参数:

    2. 高级模式

    WEB 运行界面,通过URL传递参数:

    参数 params 的值为以下 JSON 数据 encodeURIComponent 后得到