检测到您已登录华为云国际站账号,为了您更好的体验,建议您访问国际站服务网站 https://www.huaweicloud.com/intl/zh-cn
不再显示此消息
Fox项目及YApi项目中的API设计导入CodeArts API中。 API Fox项目导入 导出数据 打开API Fox对应项目,单击“项目设置 > 导出数据”,进入“导出数据”页面。 选择“Apifox”数据格式,单击”导出”,完成导出。 导入数据 打开CodeArts API首页,单击“导入项目”。
pm对象API参考 pm pm:Object pm对象,含有接口运行关联信息。可利用它获取或设置环境变量和全局变量,且访问请求信息和返回结果信息。 pm:info:Object pm.info对象,含有接口运行关联信息。 pm.info.eventName:String:获取当前
快速入门 使用CodeArts API快速设计并调试接口 访问CodeArts API产品首页,单击“网页版体验”,首次使用华为云账号登录CodeArts API的用户,系统将默认为该用户新建“示例项目”并进入项目,用户可基于示例接口认识API相关概念并熟悉产品使用方法。 使用API设计
检查响应体(JSON)中对象字段的值。例如: 响应体结构如下: 检查响应体对象中字段名为“status”的值,检查点配置如下: 检查响应体(JSON)中某个数组的对象的字段值(数组条件采用下标确定对象,下标从0开始)。例如: 响应体结构如下: 检查响应体“result”数组的第1个元素对象字段名为“userId”的值,检查点配置如下:
什么是CodeArts API API全生命周期管理一体化协作平台 CodeArts API是华为云API全生命周期管理一体化协作平台,支持开发者高效实现API设计、API开发、API测试、API托管、API运维、API变现的一站式体验。通过以API契约为锚点,CodeArts
表1 通用设置默认角色权限说明 服务资源 权限 权限说明 项目管理员 项目经理 产品经理 测试经理 运维经理 系统工程师 Committer 开发人员 测试人员 参与者 浏览者 角色 权限设置 设置角色权限 Y Y N Y N N N N N N N 成员设置 设置项目成员 Y
表1 通用设置默认角色权限说明 服务资源 权限 权限说明 项目管理员 项目经理 产品经理 测试经理 运维经理 系统工程师 Committer 开发人员 测试人员 参与者 浏览者 角色 权限设置 设置角色权限 Y Y N Y N N N N N N N 成员设置 设置项目成员 Y
API研发流程体系难以管控,缺少API全生命周期规范。 API一致性差,维护不同工具之间数据一致性非常困难、低效。 API开发流程自动化程度低。 华为云CodeArts API是API全生命周期一站式管理平台,为API设计者、开发者、管理者提供一站式解决方案,能够有效的解决上述问题。
API研发流程体系难以管控,缺少API全生命周期规范。 API一致性差,维护不同工具之间数据一致性非常困难、低效。 API开发流程自动化程度低。 华为云CodeArts API是API全生命周期一站式管理平台,为API设计者、开发者、管理者提供一站式解决方案,能够有效的解决上述问题。
API的客户端与Web端差异 CodeArts API的客户端与Web端在主要功能使用上没有明显差异,但在少部分特定场景下,Web端因受限于浏览器的限制,无法支持如设置全局代理、使用快捷键等功能。推荐使用客户端,享受更全面的功能体验。 父主题: 功能相关
免API设计不一致,提高API设计质量。API规范设计定义,请参照设置API设计规范。 编辑模式 规范性检查 设置API设计规范 单击项目名称,进入目标项目,单击“项目设置 > 设计规范设置”,进入“设计规范设置”页面。 新增设计规范 在“设计规范”页签,单击“新增设计规范”,填
API提供API设计版本管理功能,可在不同版本之间进行快速切换,也可对不同版本API接口进行直接对比。 创建版本 单击项目名称,进入目标项目,单击“项目设置 > 版本管理”,进入“版本管理”页面。 单击“新增版本”,填写版本号和描述,默认勾选“同步创建测试版本”。 单击“确定”。 单击项目名称
API提供API设计版本管理功能,可在不同版本之间进行快速切换,也可对不同版本API接口进行直接对比。 创建版本 单击项目名称,进入目标项目,单击“项目设置 > 版本管理”,进入“版本管理”页面。 单击“新增版本”,填写版本号和描述,默认勾选“同步创建测试版本”。 单击“确定”。 单击项目名称
免API设计不一致,提高API设计质量。API规范设计定义,请参照设置API设计规范。 编辑模式 规范性检查 设置API设计规范 单击项目名称,进入目标项目,单击“项目设置 > 设计规范设置”,进入“设计规范设置”页面。 新增设计规范 在“设计规范”页签,单击“新增设计规范”,填
进入接口自动化用例编辑的“脚本”页签,单击“循环”。 设置循环次数。 循环中可添加URL请求、判断、分组、等待、测试关键字。 判断 如果需要根据前序测试步骤的结果决定后续需要执行的测试步骤,可使用“if判断”。 判断设置方式如下: 进入接口自动化用例编辑的“脚本”页签,单击“if判断”。
进入接口自动化用例编辑的“脚本”页签,单击“循环”。 设置循环次数。 循环中可添加URL请求、判断、分组、等待、测试关键字。 判断 如果需要根据前序测试步骤的结果决定后续需要执行的测试步骤,可使用“if判断”。 判断设置方式如下: 进入接口自动化用例编辑的“脚本”页签,单击“if判断”。
插件管理 在插件管理页面中可以查看APIG和ROMA实例,还可以根据需要购买实例。 单击项目名称,进入目标项目,单击“项目设置 > 插件管理”,进入“插件管理”页面。 单击实例名称,可进入实例详情页面,查看实例详情。 单击“购买运行时实例”旁的下拉框,选择“购买APIG实例”或者
插件管理 在插件管理页面中可以查看APIG和ROMA实例,还可以根据需要购买实例。 单击项目名称,进入目标项目,单击“项目设置 > 插件管理”,进入“插件管理”页面。 单击实例名称,可进入实例详情页面,查看实例详情。 单击“购买运行时实例”旁的下拉框,选择“购买APIG实例”或者
前置脚本 前置脚本是在请求发送前执行的代码片段。例如需要在请求头中生成时间戳、打印日志、设置随机参数值等。可以在接口的“前置脚本”页面中单击“添加前置操作 > 自定义脚本”,发送接口请求前将自动运行前置脚本。 打印日志 可以通过“console.log()”将需要的变量打印在控制台,用以查看某个变量的当前值。
前置脚本 前置脚本是在请求发送前执行的代码片段。例如需要在请求头中生成时间戳、打印日志、设置随机参数值等。可以在接口的“前置脚本”页面中单击“添加前置操作 > 自定义脚本”,发送接口请求前将自动运行前置脚本。 打印日志 可以通过“console.log()”将需要的变量打印在控制台,用以查看某个变量的当前值。