计费说明 CodeArts API属于开发者生态工具,使用软件开发生产线CodeArts的套餐计费规则,用户可以登录CodeArts控制台购买套餐。 CodeArts API将“快捷调试”,“API设计”,“API Mock”,“API发布”等特性免费开放给所有开发者,用户仅需要开通
使用JS类库 内置类库列表 断言 chai (v4.2.0):用于断言BDD/TDD断言。 加密解密库 jsrsasign(10.3.0):用于RSA加密/解密。 Encode、Decode 库 crypto-js(v3.1.9-1):编码/解码库,基本包含常用的编码、解码方式,如
产品优势 API全流程高效协同 API设计、开发、测试等关键开发流程一站式协同。 API托管、运维、变现等运营流程一体化协同。 API全流程数据自动同步。 灵活API设计方式 支持表单可视化编辑设计API。 支持Swagger编辑器原生开发者体验。 API设计和API文档 100%
API设计 API(应用程序编程接口)设计是API全生命周期的第一步,其含义是通过规定接口的路径、所属目录、Tag、请求参数、请求体等来定义接口,从而帮助开发人员在沟通中对某一接口有着同样、确定的定义。 新建API 进入CodeArts API目标项目后,单击左侧搜索框旁边的,选择下拉选项中的
添加测试步骤 接口自动化测试用例可包括三个阶段:准备阶段、测试阶段、销毁阶段。 准备阶段对应的“前置步骤”,即测试的前置准备条件;测试阶段对应“测试步骤”,实现接口的功能测试;销毁阶段对应“后置步骤”,实现准备阶段和测试阶段数据的释放或恢复,保证测试用例可重复执行。 准备阶段(可选
使用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规则管理页面或接口级高级Mock页面。 目录级Mock规则管理页面 单击“API设计”,然后单击接口目录右侧的,选择“Mock规则管理”。 进入“Mock规则管理”页面,可以查看当前目录下所有接口和接口对应的Mock规则
API设计 API(应用程序编程接口)设计是API全生命周期的第一步,其含义是通过规定接口的路径、所属目录、Tag、请求参数、请求体等来定义接口,从而帮助开发人员在沟通中对某一接口有着同样、确定的定义。 新建API 进入CodeArts API目标项目后,单击左侧搜索框旁边的,选择下拉选项中的
API网关注册 CodeArts API支持将状态为“已测完”或“已发布”的API注册到APIG网关实例,用户需要登录APIG实例,将已注册的API发布,API即可在APIG中正式生效。 API从注册到发布的管理流程如下: 准备工作 在使用API网关注册功能前,用户需要先购买APIG
测试流程控制条件 在测试用例中,可能会有复杂的测试场景,因此CodeArts API提供了多种流程控制条件:循环、判断、分组、等待时间。 循环 当测试步骤需要重复执行时,可以指定重复执行次数。 进入接口自动化用例编辑的“脚本”页签,单击“循环”。 设置循环次数。 循环中可添加URL
响应提取 响应提取是提取接口响应结果的某一部分,命名为参数,供后续测试步骤参数化调用。响应提取需要在前序测试步骤定义,后续测试步骤使用。 在前序测试步骤中,在“响应提取”页签创建要传递的参数。响应提取来源用到内置参数,请参考内置参数了解如何使用内置参数。响应提取同时支持正则表达式的匹配
API中心发布 介绍如何将已开发好的API分享至API中心。 前提条件 已完成服务商入驻。 操作步骤 单击项目名称,进入目标项目详情页面,单击“API发布 > API中心发布”。 单击“申请发布”,跳转至“创建API资产”页面。 选择导入API、填写API资产信息,参数说明请分别参见表
定时导入接口 CodeArts API支持执行定时任务来导入API接口。 单击“项目设置 > 导入数据”,默认进入“定时导入”页签。 单击“新建”,弹出“新增定时任务”窗口。 配置任务参数,参数配置请参考下表。 参数 配置说明 任务名称 定时任务名称,只允许输入字母、汉字、数字、下划线
添加测试步骤 接口自动化测试用例可包括三个阶段:准备阶段、测试阶段、销毁阶段。 准备阶段对应的“前置步骤”,即测试的前置准备条件;测试阶段对应“测试步骤”,实现接口的功能测试;销毁阶段对应“后置步骤”,实现准备阶段和测试阶段数据的释放或恢复,保证测试用例可重复执行。 准备阶段(可选
Mock规则管理 规则入口 可通过以下操作步骤进入目录级Mock规则管理页面或接口级高级Mock页面。 目录级Mock规则管理页面 单击“API设计”,然后单击接口目录右侧的,选择“Mock规则管理”。 进入“Mock规则管理”页面,可以查看当前目录下所有接口和接口对应的Mock规则
产品优势 API全流程高效协同 API设计、开发、测试等关键开发流程一站式协同。 API托管、运维、变现等运营流程一体化协同。 API全流程数据自动同步。 灵活API设计方式 支持表单可视化编辑设计API。 支持Swagger编辑器原生开发者体验。 API设计和API文档 100%
推送接口 CodeArts API支持将设计完成的接口推送至第三方URL。 单击“项目设置 > 导出数据”,默认进入“第三方推送”页签。 单击“新建”,弹出“新增同步任务”窗口。 配置任务参数,参数配置请参考下表。 参数 配置说明 任务名称 同步任务名称,只允许输入字母、汉字、数字
定时导入接口 CodeArts API支持执行定时任务来导入API接口。 单击“项目设置 > 导入数据”,默认进入“定时导入”页签。 单击“新建”,弹出“新增定时任务”窗口。 配置任务参数,参数配置请参考下表。 参数 配置说明 任务名称 定时任务名称,只允许输入字母、汉字、数字、下划线
您即将访问非华为云网站,请注意账号财产安全