检测到您已登录华为云国际站账号,为了您更好的体验,建议您访问国际站服务网站 https://www.huaweicloud.com/intl/zh-cn
不再显示此消息
Mock规则设计 配置请求规则 请求Mock服务时,系统会根据规则中配置的参数匹配,只有规则下所有参数满足匹配条件时,才可匹配到整个规则。 请求参数,支持Query、Path、Header、Body。 Path参数只有在当前选择的接口的url中存在path变量时才可以显示配置。
Mock规则设计 配置请求规则 请求Mock服务时,系统会根据规则中配置的参数匹配,只有规则下所有参数满足匹配条件时,才可匹配到整个规则。 请求参数,支持Query、Path、Header、Body。 Path参数只有在当前选择的接口的url中存在path变量时才可以显示配置。
Mock语法说明 APIMock语法完全兼容Mock.js,并扩展了一些Mock.js没有的语法(uuid、正则表达式),Mock语法详见表1。 如现有Mock语法无法满足需求,建议使用正则表达式“@regexp”来实现灵活定制,正则表达式基本能满足各种特殊场景的需求。 表1 Mock语法
导入项目 CodeArts API提供友商项目导入功能,目前支持API Fox项目及YApi项目中的API设计导入CodeArts API中。 API Fox项目导入 导出数据 打开API Fox对应项目,单击“项目设置 > 导出数据”,进入“导出数据”页面。 选择“Apifox”数据格式,单击”导出”,完成导出。
设置Mock 默认开启云端Mock,云端Mock功能适用于团队的共同协作场景,提供一个固定地址,其他成员可以通过这个地址访问云端Mock Server。 云端Mock的优势: Mock数据统一管理 配置数据团队共享 单击项目名称,进入目标项目,单击“项目设置 > 功能设置”,默认
Mock语法说明 APIMock语法完全兼容Mock.js,并扩展了一些Mock.js没有的语法(uuid、正则表达式),Mock语法详见表1。 如现有Mock语法无法满足需求,建议使用正则表达式“@regexp”来实现灵活定制,正则表达式基本能满足各种特殊场景的需求。 表1 Mock语法
导入项目 CodeArts API提供友商项目导入功能,目前支持API Fox项目及YApi项目中的API设计导入CodeArts API中。 API Fox项目导入 导出数据 打开API Fox对应项目,单击“项目设置 > 导出数据”,进入“导出数据”页面。 选择“Apifox”数据格式,单击”导出”,完成导出。
Mock规则管理 规则入口 可通过以下操作步骤进入目录级Mock规则管理页面或接口级高级Mock页面。 目录级Mock规则管理页面 单击“API设计”,然后单击接口目录右侧的,选择“Mock规则管理”。 进入“Mock规则管理”页面,可以查看当前目录下所有接口和接口对应的Mock规则。
访问CodeArts API服务 浏览器访问 客户端访问 父主题: 使用CodeArts API服务
提交审核 审核功能开启后,对于API接口的操作都需要提交审核并通过后才可生效。 查看接口变更对比 当进行新增、修改、删除API接口的操作后,接口列表会出现相应提示图标。 单击变更的API接口,在API“文档”页面单击“变更对比”。 弹出“变更对比”页面,可查看API接口变更前后的对比详情。
提交审核 审核功能开启后,对于API接口的操作都需要提交审核并通过后才可生效。 查看接口变更对比 当进行新增、修改、删除API接口的操作后,接口列表会出现相应提示图标。 单击变更的API接口,在API“文档”页面单击“变更对比”。 弹出“变更对比”页面,可查看API接口变更前后的对比详情。
创建、管理项目 创建项目 拥有创建项目权限的用户可以在CodeArts API的控制台创建新的项目。 登录CodeArts API控制台,单击“创建项目”,弹出“创建项目”窗口。 填写项目基本信息。 表1 新建项目参数说明 字段名称 是否必填 备注说明 项目名称 是 项目名称,限制128个字符。
创建、管理项目 创建项目 拥有创建项目权限的用户可以在CodeArts API的控制台创建新的项目。 登录CodeArts API控制台,单击“创建项目”,弹出“创建项目”窗口。 填写项目基本信息。 表1 新建项目参数说明 字段名称 是否必填 备注说明 项目名称 是 项目名称,限制128个字符。
在用户组列表中,单击用户组操作的“用户组管理”。 在“可选用户”中选择需要添加至用户组中的用户。如未创建IAM用户,可在IAM控制台单击“用户 > 创建用户”,创建新的IAM用户,详细步骤请参照创建IAM用户章节。 单击“确定”,完成用户授权。 用户登录并验证权限。 用户登录CodeArts API,可正常使用产品,但不可创建项目。
在用户组列表中,单击用户组操作的“用户组管理”。 在“可选用户”中选择需要添加至用户组中的用户。如未创建IAM用户,可在IAM控制台单击“用户 > 创建用户”,创建新的IAM用户,详细步骤请参照创建IAM用户章节。 单击“确定”,完成用户授权。 用户登录并验证权限。 用户登录CodeArts API,可正常使用产品,但不可创建项目。
后置脚本 后置脚本是在请求发送后执行的代码片段,主要用于验证请求返回的结果(断言)、将请求返回的结果数据写入环境变量等场景。可以在接口的“后置脚本”页面中单击“添加后置操作”,发送接口请求后将自动运行后置脚本。 断言 可以利用后置脚本验证API响应返回结果的正确性。 // 示例1:pm
管理项目成员与角色权限 管理成员与角色 管理角色权限 角色与操作权限说明 父主题: 使用CodeArts API服务
管理项目成员与角色权限 管理成员与角色 管理角色权限 角色与操作权限说明 父主题: 使用CodeArts API服务
后置脚本 后置脚本是在请求发送后执行的代码片段,主要用于验证请求返回的结果(断言)、将请求返回的结果数据写入环境变量等场景。可以在接口的“后置脚本”页面中单击“添加后置操作”,发送接口请求后将自动运行后置脚本。 断言 可以利用后置脚本验证API响应返回结果的正确性。 // 示例1:pm
前置脚本 前置脚本是在请求发送前执行的代码片段。例如需要在请求头中生成时间戳、打印日志、设置随机参数值等。可以在接口的“前置脚本”页面中单击“添加前置操作 > 自定义脚本”,发送接口请求前将自动运行前置脚本。 打印日志 可以通过“console.log()”将需要的变量打印在控制台,用以查看某个变量的当前值。