检测到您已登录华为云国际站账号,为了您更好的体验,建议您访问国际站服务网站 https://www.huaweicloud.com/intl/zh-cn
不再显示此消息
响应提取 响应提取是提取接口响应结果的某一部分,命名为参数,供后续测试步骤参数化调用。响应提取需要在前序测试步骤定义,后续测试步骤使用。 在前序测试步骤中,在“响应提取”页签创建要传递的参数。响应提取来源用到内置参数,请参考内置参数了解如何使用内置参数。响应提取同时支持正则表达式
响应提取 响应提取是提取接口响应结果的某一部分,命名为参数,供后续测试步骤参数化调用。响应提取需要在前序测试步骤定义,后续测试步骤使用。 在前序测试步骤中,在“响应提取”页签创建要传递的参数。响应提取来源用到内置参数,请参考内置参数了解如何使用内置参数。响应提取同时支持正则表达式
计费说明 CodeArts API属于开发者生态工具,使用软件开发生产线CodeArts的套餐计费规则,用户可以登录CodeArts控制台购买套餐。 CodeArts API将“快捷调试”,“API设计”,“API Mock”,“API发布”等特性免费开放给所有开发者,用户仅需要
快速入门 使用CodeArts API快速设计并调试接口 访问CodeArts API产品首页,单击“网页版体验”,首次使用华为云账号登录CodeArts API的用户,系统将默认为该用户新建“示例项目”并进入项目,用户可基于示例接口认识API相关概念并熟悉产品使用方法。 使用API设计
下载CodeArts API客户端 Windows 平台提供了桌面应用程序,可下载客户端,下载完成后解压文件,运行解压文件即可安装 CodeArts API 到您的电脑。 CodeArts API客户端下载地址如下表所示。 支持平台 下载地址 Windows latest_win
定时导入接口 CodeArts API支持执行定时任务来导入API接口。 单击“项目设置 > 导入数据”,默认进入“定时导入”页签。 单击“新建”,弹出“新增定时任务”窗口。 配置任务参数,参数配置请参考下表。 参数 配置说明 任务名称 定时任务名称,只允许输入字母、汉字、数字、下划线、中划线,长度3-64个字符。
推送接口 CodeArts API支持将设计完成的接口推送至第三方URL。 单击“项目设置 > 导出数据”,默认进入“第三方推送”页签。 单击“新建”,弹出“新增同步任务”窗口。 配置任务参数,参数配置请参考下表。 参数 配置说明 任务名称 同步任务名称,只允许输入字母、汉字、数
下载CodeArts API客户端 Windows 平台提供了桌面应用程序,可下载客户端,下载完成后解压文件,运行解压文件即可安装 CodeArts API 到您的电脑。 CodeArts API客户端下载地址如下表所示。 支持平台 下载地址 Windows latest_win
定时导入接口 CodeArts API支持执行定时任务来导入API接口。 单击“项目设置 > 导入数据”,默认进入“定时导入”页签。 单击“新建”,弹出“新增定时任务”窗口。 配置任务参数,参数配置请参考下表。 参数 配置说明 任务名称 定时任务名称,只允许输入字母、汉字、数字、下划线、中划线,长度3-64个字符。
接口审核 角色权限 API审核操作用户角色类型及操作权限说明如下: 项目角色 操作 数据范围 项目创建者 查看 所有数据 审核 所有数据 撤回 自己提交的数据 项目经理 查看 所有数据 审核 所有数据 撤回 自己提交的数据 开发人员 查看 所有数据 撤回 自己提交的数据 操作步骤
接口审核 角色权限 API审核操作用户角色类型及操作权限说明如下: 项目角色 操作 数据范围 项目创建者 查看 所有数据 审核 所有数据 撤回 自己提交的数据 项目经理 查看 所有数据 审核 所有数据 撤回 自己提交的数据 开发人员 查看 所有数据 撤回 自己提交的数据 操作步骤
提交审核 审核功能开启后,对于API接口的操作都需要提交审核并通过后才可生效。 查看接口变更对比 当进行新增、修改、删除API接口的操作后,接口列表会出现相应提示图标。 单击变更的API接口,在API“文档”页面单击“变更对比”。 弹出“变更对比”页面,可查看API接口变更前后的对比详情。
提交审核 审核功能开启后,对于API接口的操作都需要提交审核并通过后才可生效。 约束与限制 审核流程结束前,提交审核的API接口将处于锁定状态,不可编辑和删除。 查看接口变更对比 当进行新增、修改、删除API接口的操作后,接口列表会出现相应提示图标。 单击变更的API接口,在API“文档”页面单击“变更对比”。
管理角色权限 为项目各个角色设置不同操作权限,包括项目基本信息的编辑和归档、角色及权限的设置和成员设置,还可以根据需要自定义角色类型并授权。 修改系统角色的权限 单击项目名称,进入目标项目,单击“项目设置 > 权限管理 > 权限”,进入权限管理页面。 选择左侧角色名称,在右侧单击“编辑”可为角色勾选设置不同操作权限。
管理角色权限 为项目各个角色设置不同操作权限,包括项目基本信息的编辑和归档、角色及权限的设置和成员设置,还可以根据需要自定义角色类型并授权。 修改系统角色的权限 单击项目名称,进入目标项目,单击“项目设置 > 权限管理 > 权限”,进入权限管理页面。 选择左侧角色名称,在右侧单击“编辑”可为角色勾选设置不同操作权限。
测试检查点 在测试步骤请求中可以设置请求结果的检查点,方便用户检测当前接口的返回值,验证测试步骤是否得到预期结果。 设置建议 推荐用户设置检查点。针对接口类请求,请提供判断响应码的检查点。 当检查点设置为空,不论接口的响应码是什么,都会判断结果为成功。 检查点说明 测试检查点即请
测试检查点 在测试步骤请求中可以设置请求结果的检查点,方便用户检测当前接口的返回值,验证测试步骤是否得到预期结果。 设置建议 推荐用户设置检查点。针对接口类请求,请提供判断响应码的检查点。 当检查点设置为空,不论接口的响应码是什么,都会判断结果为成功。 检查点说明 测试检查点即请
Mock规则设计 配置请求规则 请求Mock服务时,系统会根据规则中配置的参数匹配,只有规则下所有参数满足匹配条件时,才可匹配到整个规则。 请求参数,支持Query、Path、Header、Body。 Path参数只有在当前选择的接口的url中存在path变量时才可以显示配置。
Mock规则设计 配置请求规则 请求Mock服务时,系统会根据规则中配置的参数匹配,只有规则下所有参数满足匹配条件时,才可匹配到整个规则。 请求参数,支持Query、Path、Header、Body。 Path参数只有在当前选择的接口的url中存在path变量时才可以显示配置。
快速入门 登录CodeArts API 使用华为云账号登录CodeArts API,系统默认为新用户新建“示例项目”并进入项目,用户可基于“示例项目”进行快捷调试。 新建快捷调试 进入项目后,单击搜索框旁,可根据需要选择“新建快捷调试”或“导入Postman文件”进行快捷调试。 新建快捷调试