检测到您已登录华为云国际站账号,为了您更好的体验,建议您访问国际站服务网站 https://www.huaweicloud.com/intl/zh-cn
不再显示此消息
导入接口 功能说明 CodeArts API支持导入以下API数据格式文件,方便数据迁移。 Swagger Postman(支持Collections和Environment数据集ZIP包) Jmeter Swagger URL 约束与限制 导入文件时,一个文件导入后,将会视为一
securitySchemes。大部分的Web服务都需要经过身份认证才能访问,security就是用于描述API的安全信息和访问授权协议等信息的对象,Open API支持的最常见授权方案如下: API key HTTP Oauth2.0 OpenID Connect 安全方案引入需要在
下载CodeArts API客户端 Windows 平台提供了桌面应用程序,可下载客户端,下载完成后解压文件,运行解压文件即可安装 CodeArts API 到您的电脑。 CodeArts API客户端下载地址如下表所示。 支持平台 下载地址 Windows latest_win
下载CodeArts API客户端 Windows 平台提供了桌面应用程序,可下载客户端,下载完成后解压文件,运行解压文件即可安装 CodeArts API 到您的电脑。 CodeArts API客户端下载地址如下表所示。 支持平台 下载地址 Windows latest_win
使用JS类库 内置类库列表 断言 chai (v4.2.0):用于断言BDD/TDD断言。 加密解密库 jsrsasign(10.3.0):用于RSA加密/解密。 Encode、Decode 库 crypto-js(v3.1.9-1):编码/解码库,基本包含常用的编码、解码方式,
使用JS类库 内置类库列表 断言 chai (v4.2.0):用于断言BDD/TDD断言。 加密解密库 jsrsasign(10.3.0):用于RSA加密/解密。 Encode、Decode 库 crypto-js(v3.1.9-1):编码/解码库,基本包含常用的编码、解码方式,
创建、管理项目 创建项目 拥有创建项目权限的用户可以在CodeArts API的控制台创建新的项目。 登录CodeArts API控制台,单击“创建项目”,弹出“创建项目”窗口。 填写项目基本信息。 表1 新建项目参数说明 字段名称 是否必填 备注说明 项目名称 是 项目名称,限制128个字符。
Mock语法说明 APIMock语法完全兼容Mock.js,并扩展了一些Mock.js没有的语法(uuid、正则表达式),Mock语法详见表1。 如现有Mock语法无法满足需求,建议使用正则表达式“@regexp”来实现灵活定制,正则表达式基本能满足各种特殊场景的需求。 表1 Mock语法
创建、管理项目 创建项目 拥有创建项目权限的用户可以在CodeArts API的控制台创建新的项目。 登录CodeArts API控制台,单击“创建项目”,弹出“创建项目”窗口。 填写项目基本信息。 表1 新建项目参数说明 字段名称 是否必填 备注说明 项目名称 是 项目名称,限制128个字符。
Mock语法说明 APIMock语法完全兼容Mock.js,并扩展了一些Mock.js没有的语法(uuid、正则表达式),Mock语法详见表1。 如现有Mock语法无法满足需求,建议使用正则表达式“@regexp”来实现灵活定制,正则表达式基本能满足各种特殊场景的需求。 表1 Mock语法
数据库类—MongoDBDelete 中间件类 中间件类—RedisGet 中间件类—RedisSet 中间件类—OBSWrite 中间件类—OBSDelete 中间件类—OBSQuery 中间件类—KafkaProducer 中间件类—KafkaConsumer 协议类 协议类—TCP
数据库类—MongoDBDelete 中间件类 中间件类—RedisGet 中间件类—RedisSet 中间件类—OBSWrite 中间件类—OBSDelete 中间件类—OBSQuery 中间件类—KafkaProducer 中间件类—KafkaConsumer 协议类 协议类—TCP
全局代理 CodeArts API客户端版本支持设置全局网络代理,设置后,代理应用于所有联网服务,包括连接CodeArts API服务器和发送接口请求。 打开CodeArts API客户端后,单击右上角,进入设置页面。 单击“网络代理”,进入网络代理设置页面,可根据需要选择代理模
全局代理 CodeArts API客户端版本支持设置全局网络代理,设置后,代理应用于所有联网服务,包括连接CodeArts API服务器和发送接口请求。 打开CodeArts API客户端后,单击右上角,进入设置页面。 单击“网络代理”,进入网络代理设置页面,可根据需要选择代理模
API设计 API(应用程序编程接口)设计是API全生命周期的第一步,其含义是通过规定接口的路径、所属目录、Tag、请求参数、请求体等来定义接口,从而帮助开发人员在沟通中对某一接口有着同样、确定的定义。 新建API 进入CodeArts API目标项目后,单击左侧搜索框旁边的,选
API调试 完成API设计之后,在API文档页面单击“运行”会自动切换到API调试页面,也可以单击“调试”页签切换到API调试页面,本节介绍调试页面相关信息配置。 约束与限制 由于浏览器限制,使用CodeArts API的Web版本进行接口调试,需要先安装浏览器扩展,浏览器扩展请查看浏览器扩展。
API调试 完成API设计之后,在API文档页面单击“运行”会自动切换到API调试页面,也可以单击“调试”页签切换到API调试页面,本节介绍调试页面相关信息配置。 由于浏览器限制,使用CodeArts API的Web版本进行接口调试,需要先安装浏览器扩展,浏览器扩展请查看浏览器扩展。
发布历史 记录了客户端版本发布历史,包括新特性、问题修复及优化等内容,用户可以在该页面下载最新版本客户端。 版本号 操作系统 OS支持 更新内容 发布时间 2.2.0 Windows X86 新特性: 支持上海一region;API设计模块支持导出html格式接口文档; 项目设置模块导入数据列表支持搜索和排序;
测试检查点 在测试步骤请求中可以设置请求结果的检查点,方便用户检测当前接口的返回值,验证测试步骤是否得到预期结果。 设置建议 推荐用户设置检查点。针对接口类请求,请提供判断响应码的检查点。 当检查点设置为空,不论接口的响应码是什么,都会判断结果为成功。 检查点说明 测试检查点即请
测试检查点 在测试步骤请求中可以设置请求结果的检查点,方便用户检测当前接口的返回值,验证测试步骤是否得到预期结果。 设置建议 推荐用户设置检查点。针对接口类请求,请提供判断响应码的检查点。 当检查点设置为空,不论接口的响应码是什么,都会判断结果为成功。 检查点说明 测试检查点即请