参数说明

1. 简介

1.1 功能简介

在参数说明文档中，通过切换应用及表单可以快速查询接口调试所需要的参数。同时为开发人员提供一体式的文档、调试、代码示例生成功能，以支撑高效的开发与查阅。

1.2 使用说明

适用于有一定开发能力的企业，能够通过接口自定义开发内容，进行简道云平台对接等。

1.3 预期效果

以在参数说明界面，查看产品管理系统中的表单及字段信息为例，效果如下所示：

2. 操作步骤

2.1 操作入口

进入「开放平台 >> 开发文档」中，点击「参数说明」即可进入到参数说明详情页中。

2.2 应用切换

进入参数说明详情页后，在左上角「应用切换」处，可通过下拉框选择不同的应用。

2.3 表单信息查看

1）选择好应用之后，在左侧表单列表中选择好表单之后，即可查看到表单的相关信息。如表单所属的应用ID、表单ID、字段名称、字段ID、字段类型等。

2）若表单内的字段过多，还可通过右上角的搜索框，搜索出字段名称后进行字段信息的查看。如下所示：

2.4 API调试台

在 API 调试平台中，选择需要调试的接口，并输入相应的 API 密钥及请求参数即可进行调试。详情可参见文档：API 调试台。

2.5 设置字段别名

点击「设置字段别名」，可以对表单内的字段设置字段别名。

2.6 字段JSON样例

点击「字段 JSON 样例」，可以查看表单内字段的 JSON 代码。企业可根据自身需求，复制 JSON 代码进行接口调试。​