检测到您已登录华为云国际站账号,为了您更好的体验,建议您访问国际站服务网站 https://www.huaweicloud.com/intl/zh-cn
不再显示此消息
持中文、英文、下划线、数字和“.”,且以中英文开头,长度为3-64个字符。 正文:可手动输入文字,也可使用组件插入特定的内容,如:表格、超链接、图片;正文样式也可以使用组件进行调整;正文编辑支持全屏模式;在左侧编辑正文时,右侧会同步展示编辑内容,便于查看、修改样式等。 编辑完成后
API调试 完成API设计之后,在API文档页面单击“运行”会自动切换到API调试页面,也可以单击“调试”页签切换到API调试页面,本节介绍调试页面相关信息配置。 由于浏览器限制,使用CodeArts API的Web版本进行接口调试,需要先安装浏览器扩展,浏览器扩展请查看浏览器扩展。
接口审核 审核设置 提交审核 接口审核 父主题: API设计
持中文、英文、下划线、数字和“.”,且以中英文开头,长度为3-64个字符。 正文:可手动输入文字,也可使用组件插入特定的内容,如:表格、超链接、图片;正文样式也可以使用组件进行调整;正文编辑支持全屏模式;在左侧编辑正文时,右侧会同步展示编辑内容,便于查看、修改样式等。 编辑完成后
选择资产行业分类,方便API资产在API中心门户网站按行业类别被搜索。 可见范围 公开:API资产创建成功后,所有用户都能在API中心门户网站中看到该API资产。 私有:API资产创建成功后,仅当前用户能在API中心门户网站中看到该API资产。 API来源 API的来源,方便资产在API中心门户网站按来源被搜索。
Mock规则管理 规则入口 可通过以下操作步骤进入目录级Mock规则管理页面或接口级高级Mock页面。 目录级Mock规则管理页面 单击“API设计”,然后单击接口目录右侧的,选择“Mock规则管理”。 进入“Mock规则管理”页面,可以查看当前目录下所有接口和接口对应的Mock规则。
Mock规则设计 配置请求规则 请求Mock服务时,系统会根据规则中配置的参数匹配,只有规则下所有参数满足匹配条件时,才可匹配到整个规则。 请求参数,支持Query、Path、Header、Body。 Path参数只有在当前选择的接口的url中存在path变量时才可以显示配置。
支持json。函数需要写在vaule值位置,以“@”作为起始符。 支持xml。(本版本不支持,下个版本支持。) 不支持单独@函数。 只支持在响应体内使用mock.js。 实例如下: 输入 示例结果 { "id":@uuid(), "flag":@boolean(1, 9, true), "name"
Mock规则设计 配置请求规则 请求Mock服务时,系统会根据规则中配置的参数匹配,只有规则下所有参数满足匹配条件时,才可匹配到整个规则。 请求参数,支持Query、Path、Header、Body。 Path参数只有在当前选择的接口的url中存在path变量时才可以显示配置。
支持json。函数需要写在vaule值位置,以“@”作为起始符。 支持xml。(本版本不支持,下个版本支持。) 不支持单独@函数。 只支持在响应体内使用mock.js。 实例如下: 输入 示例结果 { "id":@uuid(), "flag":@boolean(1, 9, true), "name"
Mock规则管理 规则入口 可通过以下操作步骤进入目录级Mock规则管理页面或接口级高级Mock页面。 目录级Mock规则管理页面 单击“API设计”,然后单击接口目录右侧的,选择“Mock规则管理”。 进入“Mock规则管理”页面,可以查看当前目录下所有接口和接口对应的Mock规则。
测试检查点 在测试步骤请求中可以设置请求结果的检查点,方便用户检测当前接口的返回值,验证测试步骤是否得到预期结果。 设置建议 推荐用户设置检查点。针对接口类请求,请提供判断响应码的检查点。 当检查点设置为空,不论接口的响应码是什么,都会判断结果为成功。 检查点说明 测试检查点即请
审核设置 API设计审核为用户提供了一套成熟的审核流程,帮助检查项目中设计的API接口是否符合需求。 角色权限 项目经理和项目创建者有审核设置权限。 开启审核功能 单击“项目设置 > 功能设置”,进入“功能设置”页面。 在“审核设置”页签,审核设置按钮默认为关闭状态,单击,开启审核功能。
提交审核 审核功能开启后,对于API接口的操作都需要提交审核并通过后才可生效。 查看接口变更对比 当进行新增、修改、删除API接口的操作后,接口列表会出现相应提示图标。 单击变更的API接口,在API“文档”页面单击“变更对比”。 弹出“变更对比”页面,可查看API接口变更前后的对比详情。
导入/导出接口 导入接口 定时导入接口 导出接口 推送接口 父主题: 导入与导出
审核设置 API设计审核为用户提供了一套成熟的审核流程,帮助检查项目中设计的API接口是否符合需求。 角色权限 项目经理和项目创建者有审核设置权限。 开启审核功能 单击“项目设置 > 功能设置”,进入“功能设置”页面。 在“审核设置”页签,审核设置按钮默认为关闭状态,单击,开启审核功能。
提交审核 审核功能开启后,对于API接口的操作都需要提交审核并通过后才可生效。 约束与限制 审核流程结束前,提交审核的API接口将处于锁定状态,不可编辑和删除。 查看接口变更对比 当进行新增、修改、删除API接口的操作后,接口列表会出现相应提示图标。 单击变更的API接口,在API“文档”页面单击“变更对比”。
测试检查点 在测试步骤请求中可以设置请求结果的检查点,方便用户检测当前接口的返回值,验证测试步骤是否得到预期结果。 设置建议 推荐用户设置检查点。针对接口类请求,请提供判断响应码的检查点。 当检查点设置为空,不论接口的响应码是什么,都会判断结果为成功。 检查点说明 测试检查点即请
成员”,进入成员管理页面。默认是"成员"页签,展示当前项目下存在的成员。 添加本企业用户 本企业用户为企业用户在统一身份认证服务中已创建的IAM用户,即成员下显示的用户。 单击“添加成员”旁的下拉框,选择“添加本企业用户”。 弹出“添加本企业用户”对话框,勾选需要添加的成员,然后单击“下一步”。 选择项目角色,然后单击“完成”即可成功添加。
响应提取 响应提取是提取接口响应结果的某一部分,命名为参数,供后续测试步骤参数化调用。响应提取需要在前序测试步骤定义,后续测试步骤使用。 在前序测试步骤中,在“响应提取”页签创建要传递的参数。响应提取来源用到内置参数,请参考内置参数了解如何使用内置参数。响应提取同时支持正则表达式