API设计配置

启用规则集

1. 登录ROMA API控制台。

2. 在控制台单击，选择区域，在“ROMA API”下选择待操作的应用。

3. 在左侧导航栏单击“API设计”。

4. 在页面右上角单击“API设计配置”。
5. 在“规则集”管理页面，找到需要启用的规则集，单击“启用”。

   如需创建规则集，请参考创建规则集。

6. 在弹窗中单击“确定”。
7. 在已启用的规则集显示“当前使用”，规则集启用成功。
   • 如需取消已启用的规则集，可启用另一个规则集，将当前使用规则集覆盖。
   • 如需查看已启用规则，可单击规则集名称。

8. （可选）查看规则集详情，包含已启用规则和未启用规则，可单击“管理”或“查看”。
   

   • 管理：自己创建的规则集支持查看和编辑。
   • 查看：其他用户创建的规则集仅支持查看。
   1. 通过“问题级别”和“规则类型”选择性查看。
   2. 单击规则名称，可查看规则的“正确示例”和“错误示例”。

9. （可选）编辑规则集，可单击“管理”或“编辑”。
   • 管理：配置规则。
     • 取消已启用规则

       在“已启用”的规则中，勾选需要取消启用的规则，单击“取消启用”。

     • 启用规则

       在“未启用”的规则中，勾选需要启用的规则，单击“启用”。

   • 编辑：修改规则集名称和描述。

创建规则集

1. 登录ROMA API控制台。

2. 在控制台单击，选择区域，在“ROMA API”下选择待操作的应用。

3. 在左侧导航栏单击“API设计”。
4. 在页面右上角单击“API设计配置”。
5. 在“规则集管理”页面，单击“创建规则集”，在弹窗中填写基本信息后，单击“保存”。
6. 进入规则配置页面，在“未启用”规则中勾选需要启用的规则，单击“启用”创建完成。

设置无需检查的接口

1. 登录ROMA API控制台。

2. 在控制台单击，选择区域，在“ROMA API”下选择待操作的应用。
3. 在左侧导航栏单击“API设计”。
4. 在页面右上角单击“API设计配置”。
5. 单击“无需检查的接口”页签。
6. 单击“添加API”，选择对应API设计文件下不需要规范性检查的API。
7. 单击“保存”，设置完成。

   如需取消，单击“移除”，或选择API后，单击“批量移除”。

扩展字段配置

1. 登录ROMA API控制台。

2. 在控制台单击，选择区域，在“ROMA API”下选择待操作的应用。
3. 在左侧导航栏单击“API设计”。
4. 在页面右上角单击“API设计配置”。
5. 在“API设计配置”页面，单击“扩展字段配置”。
6. 单击“添加扩展字段”，定义扩展字段。

   表1 定义扩展字段

   信息项	描述
   Key	填写Key值。
   显示名	填写扩展字段名称。
   显示样式	填写扩展字段的值，支持文本框、单选框、复选框和下拉列表的形式。
   配置值	填写扩展字段的值，显示样式非“文本框”时，配置值必填。
   必填	若勾选，表示配置扩展字段时，扩展字段内容不能为空。
   显示区域	支持选择扩展字段在设计文件“表单”中显示的区域。 API基本信息 请求参数 数据模型基本信息 数据模型属性 将鼠标移至“显示区域”右侧的问号，单击“了解扩展字段显示区域”查看扩展字段对应区域显示详情。
   描述	填写扩展字段的描述信息。

7. 配置扩展字段。

   进入API设计文件详情，在“表单”中找到定义扩展字段时选择的区域，并配置扩展字段。