检测到您已登录华为云国际站账号,为了您更好的体验,建议您访问国际站服务网站 https://www.huaweicloud.com/intl/zh-cn
不再显示此消息
使用JS类库 内置类库列表 断言 chai (v4.2.0):用于断言BDD/TDD断言。 加密解密库 jsrsasign(10.3.0):用于RSA加密/解密。 Encode、Decode 库 crypto-js(v3.1.9-1):编码/解码库,基本包含常用的编码、解码方式,
测试流程控制条件 在测试用例中,可能会有复杂的测试场景,因此CodeArts API提供了多种流程控制条件:循环、判断、分组、等待时间。 循环 当测试步骤需要重复执行时,可以指定重复执行次数。 进入接口自动化用例编辑的“脚本”页签,单击“循环”。 设置循环次数。 循环中可添加URL请求、判断、分组、等待、测试关键字。
Mock规则设计 配置请求规则 请求Mock服务时,系统会根据规则中配置的参数匹配,只有规则下所有参数满足匹配条件时,才可匹配到整个规则。 请求参数,支持Query、Path、Header、Body。 Path参数只有在当前选择的接口的url中存在path变量时才可以显示配置。
Mock规则设计 配置请求规则 请求Mock服务时,系统会根据规则中配置的参数匹配,只有规则下所有参数满足匹配条件时,才可匹配到整个规则。 请求参数,支持Query、Path、Header、Body。 Path参数只有在当前选择的接口的url中存在path变量时才可以显示配置。
测试流程控制条件 在测试用例中,可能会有复杂的测试场景,因此CodeArts API提供了多种流程控制条件:循环、判断、分组、等待时间。 循环 当测试步骤需要重复执行时,可以指定重复执行次数。 进入接口自动化用例编辑的“脚本”页签,单击“循环”。 设置循环次数。 循环中可添加URL请求、判断、分组、等待、测试关键字。
API中心发布 介绍如何将已开发好的API分享至API中心。 前提条件 已完成服务商入驻。 操作步骤 单击项目名称,进入目标项目详情页面,单击“API发布 > API中心发布”。 单击“申请发布”,跳转至“创建API资产”页面。 选择导入API、填写API资产信息,参数说明请分别参见表1、表2。
环境与环境变量 在开发项目中,不同阶段对应不同环境,例如:前端与后端的开发人员需要在研发环境做功能联调,测试人员需要在测试环境测试,上线生产环境前也需要在预发环境验证,不同环境对应不同的前置URL和接口参数值,为了方便快速切换运行环境,快速修改前置URL等参数,CodeArts API提供了环境管理功能。
环境与环境变量 在开发项目中,不同阶段对应不同环境,例如:前端与后端的开发人员需要在研发环境做功能联调,测试人员需要在测试环境测试,上线生产环境前也需要在预发环境验证,不同环境对应不同的前置URL和接口参数值,为了方便快速切换运行环境,快速修改前置URL等参数,CodeArts API提供了环境管理功能。
API开发 CodeArts API支持生成接口请求代码和业务代码,缩短前后端开发时长,规范代码结构。 基于接口定义,CodeArts API支持自动生成各种语言和框架的请求代码和业务代码。在API设计模块,接口文档界面右侧,即可看到“生成代码”的入口。 生成接口请求代码 单击“
API开发 CodeArts API支持生成接口请求代码和业务代码,缩短前后端开发时长,规范代码结构。 基于接口定义,CodeArts API支持自动生成各种语言和框架的请求代码和业务代码。在API设计模块,接口文档界面右侧,即可看到“生成代码”的入口。 生成接口请求代码 单击“
访问客户端 客户端支持登录和未登录使用。 约束与限制 导入与导出功能需要登录后才可以继续使用。 前置脚本、后置脚本功能需要登录后才可继续使用。 登录使用 单击“登录/注册”,填写华为云账户密码进行登录。 首次登录CodeArts API服务,系统将为用户默认创建示例项目,并进入项
Mock规则管理 规则入口 可通过以下操作步骤进入目录级Mock规则管理页面或接口级高级Mock页面。 目录级Mock规则管理页面 单击“API设计”,然后单击接口目录右侧的,选择“Mock规则管理”。 进入“Mock规则管理”页面,可以查看当前目录下所有接口和接口对应的Mock规则。
Mock规则管理 规则入口 可通过以下操作步骤进入目录级Mock规则管理页面或接口级高级Mock页面。 目录级Mock规则管理页面 单击“API设计”,然后单击接口目录右侧的,选择“Mock规则管理”。 进入“Mock规则管理”页面,可以查看当前目录下所有接口和接口对应的Mock规则。
推送接口 CodeArts API支持将设计完成的接口推送至第三方URL。 单击“项目设置 > 导出数据”,默认进入“第三方推送”页签。 单击“新建”,弹出“新增同步任务”窗口。 配置任务参数,参数配置请参考下表。 参数 配置说明 任务名称 同步任务名称,只允许输入字母、汉字、数
快速入门 使用CodeArts API快速设计并调试接口 访问CodeArts API产品首页,单击“网页版体验”,首次使用华为云账号登录CodeArts API的用户,系统将默认为该用户新建“示例项目”并进入项目,用户可基于示例接口认识API相关概念并熟悉产品使用方法。 使用API设计
pm对象API参考 pm pm:Object pm对象,含有接口运行关联信息。可利用它获取或设置环境变量和全局变量,且访问请求信息和返回结果信息。 pm:info:Object pm.info对象,含有接口运行关联信息。 pm.info.eventName:String:获取当前
pm对象API参考 pm pm:Object pm对象,含有接口运行关联信息。可利用它获取或设置环境变量和全局变量,且访问请求信息和返回结果信息。 pm:info:Object pm.info对象,含有接口运行关联信息。 pm.info.eventName:String:获取当前
版本管理 CodeArts API提供API设计版本管理功能,可在不同版本之间进行快速切换,也可对不同版本API接口进行直接对比。 创建版本 单击项目名称,进入目标项目,单击“项目设置 > 版本管理”,进入“版本管理”页面。 单击“新增版本”,填写版本号和描述,默认勾选“同步创建测试版本”。
版本管理 CodeArts API提供API设计版本管理功能,可在不同版本之间进行快速切换,也可对不同版本API接口进行直接对比。 约束与限制 克隆成项目时,只支持API设计模块中的API接口设计克隆为新项目中API设计模块的接口设计,API测试模块暂不支持克隆当前API测试模块相关测试用例与测试套件。
API调试 完成API设计之后,在API文档页面单击“运行”会自动切换到API调试页面,也可以单击“调试”页签切换到API调试页面,本节介绍调试页面相关信息配置。 约束与限制 由于浏览器限制,使用CodeArts API的Web版本进行接口调试,需要先安装浏览器扩展,浏览器扩展请查看浏览器扩展。