检测到您已登录华为云国际站账号,为了您更好的体验,建议您访问国际站服务网站 https://www.huaweicloud.com/intl/zh-cn
不再显示此消息
环境与环境变量 在开发项目中,不同阶段对应不同环境,例如:前端与后端的开发人员需要在研发环境做功能联调,测试人员需要在测试环境测试,上线生产环境前也需要在预发环境验证,不同环境对应不同的前置URL和接口参数值,为了方便快速切换运行环境,快速修改前置URL等参数,CodeArts API提供了环境管理功能。
数据模型 数据模型和编程语言里的数据结构概念类似,主要用于接口设计场景中的“返回响应”和json/xml类型的“Body参数”。 在设计API的Body体或响应体时,可以直接引用公共数据结构。 数据结构被引用后,可以在数据结构的文档页面查看引用当前数据结构的API和模型。 公共响应
环境与环境变量 在开发项目中,不同阶段对应不同环境,例如:前端与后端的开发人员需要在研发环境做功能联调,测试人员需要在测试环境测试,上线生产环境前也需要在预发环境验证,不同环境对应不同的前置URL和接口参数值,为了方便快速切换运行环境,快速修改前置URL等参数,CodeArts API提供了环境管理功能。
CodeArts API提供高级Mock功能,可以查询和定义调试接口的Mock规则。 单击接口的“高级Mock”页签,可以查看该接口对应的Mock规则。 单击“查询产品列表”,弹出“编辑Mock规则”页面。 可以查看Mock规则的请求参数和返回响应,可根据需要进行编辑。 新建快捷调试 单
数据模型 数据模型和编程语言里的数据结构概念类似,主要用于接口设计场景中的“返回响应”和json/xml类型的“Body参数”。 在设计API的Body体或响应体时,可以直接引用公共数据结构。 数据结构被引用后,可以在数据结构的文档页面查看引用当前数据结构的API和模型。 公共响应
创建、管理项目 创建项目 拥有创建项目权限的用户可以在CodeArts API的控制台创建新的项目。 登录CodeArts API控制台,单击“创建项目”,弹出“创建项目”窗口。 填写项目基本信息。 表1 新建项目参数说明 字段名称 是否必填 备注说明 项目名称 是 项目名称,限制128个字符。
创建、管理项目 创建项目 拥有创建项目权限的用户可以在CodeArts API的控制台创建新的项目。 登录CodeArts API控制台,单击“创建项目”,弹出“创建项目”窗口。 填写项目基本信息。 表1 新建项目参数说明 字段名称 是否必填 备注说明 项目名称 是 项目名称,限制128个字符。
前置脚本是在请求发送前执行的代码片段。例如需要在请求头中生成时间戳、打印日志、设置随机参数值等。可以在接口的“前置脚本”页面中单击“添加前置操作 > 自定义脚本”,发送接口请求前将自动运行前置脚本。 打印日志 可以通过“console.log()”将需要的变量打印在控制台,用以查看某个变量的当前值。
前置脚本是在请求发送前执行的代码片段。例如需要在请求头中生成时间戳、打印日志、设置随机参数值等。可以在接口的“前置脚本”页面中单击“添加前置操作 > 自定义脚本”,发送接口请求前将自动运行前置脚本。 打印日志 可以通过“console.log()”将需要的变量打印在控制台,用以查看某个变量的当前值。
导入Postman文件 单击“导入Postman文件”,弹出“导入Postman文件”对话框。 上传需要导入的Postman文件,选择导入范围,可选择“全部”或者“选择快捷调试”。 导入通过Postman导出的文件时,接口示例会被同时导入为快捷调试接口,名称和Postman中接口示例名称相同。
并行开发:在被依赖模块未开发完成时,使用Mock服务替代真实业务服务场景,可进行并行开发。 依赖服务不稳定:当依赖服务不稳定时,会导致自动化测试用例失败,使用Mock服务替代真实服务,可以保证自动化测试稳定执行,提升流水线的健壮性。 构造异常场景:测试时需要构造某些异常数据或延迟响应等异常场景,真实服务通常无法满足
CodeArts API服务功能概览 功能名称 功能描述 API设计 通过表单编辑和Swagger原生编辑器设计API,并利用API规范检查保证API设计质量。 API文档 自动生成API使用文档,支持API文档快速索引。 API开发 自动生成API前端SDK和后端框架代码。 API
并行开发:在被依赖模块未开发完成时,使用Mock服务替代真实业务服务场景,可进行并行开发。 依赖服务不稳定:当依赖服务不稳定时,会导致自动化测试用例失败,使用Mock服务替代真实服务,可以保证自动化测试稳定执行,提升流水线的健壮性。 构造异常场景:测试时需要构造某些异常数据或延迟响应等异常场景,真实服务通常无法满足
CodeArts API服务功能概览 功能名称 功能描述 API设计 通过表单编辑和Swagger原生编辑器设计API,并利用API规范检查保证API设计质量。 API文档 自动生成API使用文档,支持API文档快速索引。 API开发 自动生成API前端SDK和后端框架代码。 API
2024-07-30 2.0.6 Windows X86 新特性: 项目管理支持YApi文件导入;快捷调试模块中,表单支持复制和另存为的便捷操作,URL支持引入环境变量;API设计模块中,接口导出功能支持Swagger2.0和JSON格式。 2024-06-04 2.0.5 Windows X86
弹出“导入项目”对话框,选择导入文件格式为“YApi”,选择需要导入的YApi文件。 在“导入项目”对话框输入项目名称,单击“确定”。 弹出“导入预览”对话框,可预览所有导入数据,然后单击“导入”。 弹出导入进度对话框,可查看导入进度。 导入完成后,可进入导入项目,查看导入的接口。 当导入请求体和响应体结
弹出“导入项目”对话框,选择导入文件格式为“YApi”,选择需要导入的YApi文件。 在“导入项目”对话框输入项目名称,单击“确定”。 弹出“导入预览”对话框,可预览所有导入数据,然后单击“导入”。 弹出导入进度对话框,可查看导入进度。 导入完成后,可进入导入项目,查看导入的接口。 当导入请求体和响应体结
API提供不同版本接口的导出功能。 在“版本管理”页面,单击目标版本所在行的,选择“导出”。 选择文件在本地存储位置、设置文件名,保存到本地,解压后可查看导出的接口文件。 测试用例导入 CodeArts API提供不同版本测试用例的导入功能。 在“版本管理”页面,单击目标版本操作列的,选择“导入”。
数据。 测试工程师根据设计文档在JMeter写好的测试用例,如果设计修改则需要重新同步用例的接口参数。 API后端服务的代码实现、软件包构建、环境部署、测试脚本修改运行等一系列流程,需要手工部署。 从研发场景出发,API开发流程的痛点问题可以总结为: API研发流程体系难以管控,缺少API全生命周期规范。
数据。 测试工程师根据设计文档在JMeter写好的测试用例,如果设计修改则需要重新同步用例的接口参数。 API后端服务的代码实现、软件包构建、环境部署、测试脚本修改运行等一系列流程,需要手工部署。 从研发场景出发,API开发流程的痛点问题可以总结为: API研发流程体系难以管控,缺少API全生命周期规范。