检测到您已登录华为云国际站账号,为了您更好的体验,建议您访问国际站服务网站 https://www.huaweicloud.com/intl/zh-cn
不再显示此消息
功能总览 全部 API设计 API Mock API测试 API管理运维 API设计 API设计和API文档100%一致,所写即所得,以使用者视角定义API。 一键新建API、Markdown,Swagger标准文件一键导入。 Swagger 原生&结构表单API可视化编辑,专业
创建、管理项目 创建项目 拥有创建项目权限的用户可以在CodeArts API的控制台创建新的项目。 登录CodeArts API控制台,单击“创建项目”,弹出“创建项目”窗口。 填写项目基本信息。 表1 新建项目参数说明 字段名称 是否必填 备注说明 项目名称 是 项目名称,限制128个字符。
创建、管理项目 创建项目 拥有创建项目权限的用户可以在CodeArts API的控制台创建新的项目。 登录CodeArts API控制台,单击“创建项目”,弹出“创建项目”窗口。 填写项目基本信息。 表1 新建项目参数说明 字段名称 是否必填 备注说明 项目名称 是 项目名称,限制128个字符。
导入Swagger文件生成数据 在右侧“关键字库”界面,单击“导入接口”。 在弹出的“导入接口”页面,单击“点击添加文件或拖拽上传”,选择配置好的Swagger接口文档,单击“确定”,完成Swagger文件导入。 文档导入成功后,系统自动解析生成脚本模板,脚本模板包含了接口的基本描述信息。可以从“关键字库”界
选择配置好的Swagger接口文档,单击“确定”,完成Swagger文件导入。 文档导入成功后,系统自动解析生成脚本模板,脚本模板包含了接口的基本描述信息。可以从“关键字库”界面单击“+”或直接拖拽接口添加至测试步骤,只需要按模板输入接口参数就可以进行测试。 具体请参考CodeArts
CodeArts API提供基于JavaScript的脚本引入,通过脚本可以实现在快捷调试或接口请求时添加动态行为。脚本执行流程如图: CodeArts API兼容Postman脚本语法,可以将Postman脚本迁移到CodeArts API中使用。 CodeArts API脚本能力仅限于快捷调试、接口调试、接口调试用例。
计费说明 CodeArts API属于开发者生态工具,使用软件开发生产线CodeArts的套餐计费规则,用户可以登录CodeArts控制台购买套餐。 CodeArts API将“快捷调试”,“API设计”,“API Mock”,“API发布”等特性免费开放给所有开发者,用户仅需要
后置脚本是在请求发送后执行的代码片段,主要用于验证请求返回的结果(断言)、将请求返回的结果数据写入环境变量等场景。可以在接口的“后置脚本”页面中单击“添加后置操作”,发送接口请求后将自动运行后置脚本。 断言 可以利用后置脚本验证API响应返回结果的正确性。 // 示例1:pm.response.to.have pm.test('Response
CodeArts API提供基于JavaScript的脚本引入,通过脚本可以实现在快捷调试或接口请求时添加动态行为。脚本执行流程如图: CodeArts API兼容Postman脚本语法,可以将Postman脚本迁移到CodeArts API中使用。 CodeArts API脚本能力仅限于快捷调试、接口调试、接口调试用例。
管理成员与角色 项目创建完成后,当用户需要团队协作来完成这个项目时,可以邀请同一个华为云账号下的其他IAM用户加入项目,并给成员分配角色。 前提条件 拥有“通用设置”->“项目”的编辑权限。 拥有“通用设置”->“角色”->“成员设置”权限,可以添加成员或将成员移出项目。 拥有“
运行&报告 运行测试套件 在待执行测试套件详情页面,单击“执行”,运行测试套件。 查看测试报告 页面右侧可快速查看最近测试结果。 单击测试结果的,可查看测试结果的运行报告。 单击”更多执行历史”,可查看历史测试结果的运行报告。 父主题: 测试套件管理
响应头 表示接口返回的响应头。 是 检查点的属性字段 参数传递的属性字段 检查点:判断响应头中的token等于abcd。 设置方法:设置来源为响应头,属性为token(前提条件响应头有token),设置比较符为等于(字符串、不区分大小写),设置目标值为abcd。 响应码 表示接口返回的响应码。
运行&报告 用例调试 在“测试用例”页面,单击“调试”,开始执行测试用例。 查看运行结果 调试完成后,可快速查看具体用例执行成功或失败的用时。 单击单条结果记录,可查看执行的详细信息。 父主题: 测试用例管理
CodeArts API 教你如何利用Mock功能及调试API 02:47 使用API Mock调试API CodeArts API 带您熟悉CodeArts API中的API设计审核 02:27 API设计审核 CodeArts API 介绍如何通过CodeArts API的自动化代码生成能力进行API开发
前置脚本 前置脚本是在请求发送前执行的代码片段。例如需要在请求头中生成时间戳、打印日志、设置随机参数值等。可以在接口的“前置脚本”页面中单击“添加前置操作 > 自定义脚本”,发送接口请求前将自动运行前置脚本。 打印日志 可以通过“console.log()”将需要的变量打印在控制台,用以查看某个变量的当前值。
前置脚本 前置脚本是在请求发送前执行的代码片段。例如需要在请求头中生成时间戳、打印日志、设置随机参数值等。可以在接口的“前置脚本”页面中单击“添加前置操作 > 自定义脚本”,发送接口请求前将自动运行前置脚本。 打印日志 可以通过“console.log()”将需要的变量打印在控制台,用以查看某个变量的当前值。
新建测试用例 操作步骤 单击“API测试”菜单,进入测试用例管理主页面,可通过以下两种入口新建测试用例。 入口一:单击主页面的“新建测试用例”选项。 入口二:单击左侧测试用例旁边的,选择下拉选项中的“新建测试用例”选项。 进入“新建测试用例”页面,输入测试用例的名称,根据需要配置
测试流程控制条件 在测试用例中,可能会有复杂的测试场景,因此CodeArts API提供了多种流程控制条件:循环、判断、分组、等待时间。 循环 当测试步骤需要重复执行时,可以指定重复执行次数。 进入接口自动化用例编辑的“脚本”页签,单击“循环”。 设置循环次数。 循环中可添加URL请求、判断、分组、等待、测试关键字。
客户端新增未登录使用快捷调试能力;API设计模块新增设计审核能力、优化Swagger文件导入和Postman全量导入;API发布模块新增注册APIG网关能力。 2024-04-11 2.0.3 Windows X86 新特性: 项目管理模块新增导入Apifox项目能力;API测试模块新增关键字库
定时导入接口 CodeArts API支持执行定时任务来导入API接口。 单击“项目设置 > 导入数据”,默认进入“定时导入”页签。 单击“新建”,弹出“新增定时任务”窗口。 配置任务参数,参数配置请参考下表。 参数 配置说明 任务名称 定时任务名称,只允许输入字母、汉字、数字、下划线、中划线,长度3-64个字符。