检测到您已登录华为云国际站账号,为了您更好的体验,建议您访问国际站服务网站 https://www.huaweicloud.com/intl/zh-cn
不再显示此消息
项目概况 进入CodeArts API目标项目后,默认进入项目概况页面,可查看项目下数据统计及API集合情况。 父主题: API设计
、请求参数、请求体等来定义接口,从而帮助开发人员在沟通中对某一接口有着同样、确定的定义。 新建API 进入CodeArts API目标项目后,单击左侧搜索框旁边的,选择下拉选项中的“新建API接口”,创建http类型接口。 设计API 接口文档应针对以下要素进行设计: 接口基本信息
request.auth:获取请求的身份验证信息。 对于响应的处理 pm.response 在后置脚本中pm.response接口请求完成后返回响应信息,Response SDK 参考。 response包含了以下结构: pm.response.code:Number:获取响应码。
、请求参数、请求体等来定义接口,从而帮助开发人员在沟通中对某一接口有着同样、确定的定义。 新建API 进入CodeArts API目标项目后,单击左侧搜索框旁边的,选择下拉选项中的“新建API接口”,创建http类型接口。 设计API 接口文档应针对以下要素进行设计: 接口基本信息
request.auth:获取请求的身份验证信息。 对于响应的处理 pm.response 在后置脚本中pm.response接口请求完成后返回响应信息,Response SDK 参考。 response包含了以下结构: pm.response.code:Number:获取响应码。
访问客户端 客户端支持登录和未登录使用。 约束与限制 导入与导出功能需要登录后才可以继续使用。 前置脚本、后置脚本功能需要登录后才可继续使用。 登录使用 单击“登录/注册”,填写华为云账户密码进行登录。 首次登录CodeArts API服务,系统将为用户默认创建示例项目,并进入项
后置脚本 后置脚本是在请求发送后执行的代码片段,主要用于验证请求返回的结果(断言)、将请求返回的结果数据写入环境变量等场景。可以在接口的“后置脚本”页面中单击“添加后置操作”,发送接口请求后将自动运行后置脚本。 断言 可以利用后置脚本验证API响应返回结果的正确性。 // 示例1:pm
提交审核 审核功能开启后,对于API接口的操作都需要提交审核并通过后才可生效。 查看接口变更对比 当进行新增、修改、删除API接口的操作后,接口列表会出现相应提示图标。 单击变更的API接口,在API“文档”页面单击“变更对比”。 弹出“变更对比”页面,可查看API接口变更前后的对比详情。
提交审核 审核功能开启后,对于API接口的操作都需要提交审核并通过后才可生效。 约束与限制 审核流程结束前,提交审核的API接口将处于锁定状态,不可编辑和删除。 查看接口变更对比 当进行新增、修改、删除API接口的操作后,接口列表会出现相应提示图标。 单击变更的API接口,在API“文档”页面单击“变更对比”。
后置脚本 后置脚本是在请求发送后执行的代码片段,主要用于验证请求返回的结果(断言)、将请求返回的结果数据写入环境变量等场景。可以在接口的“后置脚本”页面中单击“添加后置操作”,发送接口请求后将自动运行后置脚本。 断言 可以利用后置脚本验证API响应返回结果的正确性。 // 示例1:pm
测试工程师根据设计文档在JMeter写好的测试用例,如果设计修改则需要重新同步用例的接口参数。 API后端服务的代码实现、软件包构建、环境部署、测试脚本修改运行等一系列流程,需要手工部署。 从研发场景出发,API开发流程的痛点问题可以总结为: API研发流程体系难以管控,缺少API全生命周期规范。 A
测试工程师根据设计文档在JMeter写好的测试用例,如果设计修改则需要重新同步用例的接口参数。 API后端服务的代码实现、软件包构建、环境部署、测试脚本修改运行等一系列流程,需要手工部署。 从研发场景出发,API开发流程的痛点问题可以总结为: API研发流程体系难以管控,缺少API全生命周期规范。 A
运行&报告 用例调试 在“测试用例”页面,单击“调试”,开始执行测试用例。 查看运行结果 调试完成后,可快速查看具体用例执行成功或失败的用时。 单击单条结果记录,可查看执行的详细信息。 父主题: 测试用例管理
运行&报告 用例调试 在“测试用例”页面,单击“调试”,开始执行测试用例。 查看运行结果 调试完成后,可快速查看具体用例执行成功或失败的用时。 单击单条结果记录,可查看执行的详细信息。 父主题: 测试用例管理
CodeArts API支持的系统权限如下: DevCloud Console ReadOnlyAccess:软件开发生产线控制台只读权限,授权后可正常使用CodeArts API产品,但不可创建项目。 DevCloud Console FullAccess:软件开发生产线控制台管理员
安全模型 安全模型类别提供“http”、“apikey”、“oauth2”、“openIdConnect”四种类型选择,选择不同类型的安全模型后,需要在方案内容中完善相关必填信息,用于API设计中“安全方案”的引用。在安全模型的文档页可以查看引用当前安全模型的API。 公共响应头 接
安全模型 安全模型类别提供“http”、“apikey”、“oauth2”、“openIdConnect”四种类型选择,选择不同类型的安全模型后,需要在方案内容中完善相关必填信息,用于API设计中“安全方案”的引用。在安全模型的文档页可以查看引用当前安全模型的API。 公共响应头 接
使用华为云账号登录CodeArts API,系统默认为新用户新建“示例项目”并进入项目,用户可基于“示例项目”进行快捷调试。 新建快捷调试 进入项目后,单击搜索框旁,可根据需要选择“新建快捷调试”或“导入Postman文件”进行快捷调试。 新建快捷调试 单击“新建快捷调试”,生成“快捷调试”页签。
Postman(支持Collections和Environment数据集ZIP包) Jmeter Swagger URL 约束与限制 导入文件时,一个文件导入后,将会视为一个根目录,一个根目录中不允许存在URL相同的接口。 手动导入 通过主页面的“更多功能”选项或单击左上角搜索框旁边的,可以展示当前支持的导入选项,可根据需要选择。
销毁阶段(可选):后置步骤。 为了不影响其它测试用例执行或保证当前测试用例可重复执行,建议在每次测试结束后还原测试数据。如果没有数据需要销毁,可以忽略此阶段。 操作步骤 创建接口自动化测试用例后,在测试用例页面,单击“脚本 > 测试步骤”页签,可以使用多种方式添加测试步骤。 从接口/接口用例导入