检测到您已登录华为云国际站账号,为了您更好的体验,建议您访问国际站服务网站 https://www.huaweicloud.com/intl/zh-cn
不再显示此消息
产品优势 API全流程高效协同 API设计、开发、测试等关键开发流程一站式协同。 API托管、运维、变现等运营流程一体化协同。 API全流程数据自动同步。 灵活API设计方式 支持表单可视化编辑设计API。 支持Swagger编辑器原生开发者体验。 API设计和API文档 100%
后置脚本 后置脚本是在请求发送后执行的代码片段,主要用于验证请求返回的结果(断言)、将请求返回的结果数据写入环境变量等场景。可以在接口的“后置脚本”页面中单击“添加后置操作”,发送接口请求后将自动运行后置脚本。 断言 可以利用后置脚本验证API响应返回结果的正确性。 // 示例1:
使用JS类库 内置类库列表 断言 chai (v4.2.0):用于断言BDD/TDD断言。 加密解密库 jsrsasign(10.3.0):用于RSA加密/解密。 Encode、Decode 库 crypto-js(v3.1.9-1):编码/解码库,基本包含常用的编码、解码方式,如
后置脚本 后置脚本是在请求发送后执行的代码片段,主要用于验证请求返回的结果(断言)、将请求返回的结果数据写入环境变量等场景。可以在接口的“后置脚本”页面中单击“添加后置操作”,发送接口请求后将自动运行后置脚本。 断言 可以利用后置脚本验证API响应返回结果的正确性。 // 示例1:
Mock语法说明 APIMock语法完全兼容Mock.js,并扩展了一些Mock.js没有的语法(uuid、正则表达式),Mock语法详见表1。 如现有Mock语法无法满足需求,建议使用正则表达式“@regexp”来实现灵活定制,正则表达式基本能满足各种特殊场景的需求。 表1 Mock
Mock语法说明 APIMock语法完全兼容Mock.js,并扩展了一些Mock.js没有的语法(uuid、正则表达式),Mock语法详见表1。 如现有Mock语法无法满足需求,建议使用正则表达式“@regexp”来实现灵活定制,正则表达式基本能满足各种特殊场景的需求。 表1 Mock
API调试 完成API设计之后,在API文档页面单击“运行”会自动切换到API调试页面,也可以单击“调试”页签切换到API调试页面,本节介绍调试页面相关信息配置。 由于浏览器限制,使用CodeArts API的Web版本进行接口调试,需要先安装浏览器扩展,浏览器扩展请查看浏览器扩展
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):编码/解码库,基本包含常用的编码、解码方式,如
API设计 API(应用程序编程接口)设计是API全生命周期的第一步,其含义是通过规定接口的路径、所属目录、Tag、请求参数、请求体等来定义接口,从而帮助开发人员在沟通中对某一接口有着同样、确定的定义。 新建API 进入CodeArts API目标项目后,单击左侧搜索框旁边的,选择下拉选项中的
API调试 完成API设计之后,在API文档页面单击“运行”会自动切换到API调试页面,也可以单击“调试”页签切换到API调试页面,本节介绍调试页面相关信息配置。 由于浏览器限制,使用CodeArts API的Web版本进行接口调试,需要先安装浏览器扩展,浏览器扩展请查看浏览器扩展
发布历史 记录了客户端版本发布历史,包括新特性、问题修复及优化等内容,用户可以在该页面下载最新版本客户端。 版本号 操作系统 OS支持 更新内容 发布时间 2.1.0 Windows X86 新特性: 项目支持分组功能、支持显示IPD类型的项目;新增系统公告能力,包含“测试计划”套餐试用提示
产品功能 表1 CodeArts API服务功能概览 功能名称 功能描述 API设计 通过表单编辑和Swagger原生编辑器设计API,并利用API规范检查保证API设计质量。 API文档 自动生成API使用文档,支持API文档快速索引。 API开发 自动生成API前端SDK和后端框架代码
IAM账号进入CodeArts API首页报错 IAM账号首次进入CodeArts API首页报错,需要给IAM账号进行授权。 CodeArts API支持的系统权限如下: DevCloud Console ReadOnlyAccess:软件开发生产线控制台只读权限,授权后可正常使用
公共模型 公共模型提供API设计时所需公共数据的定义,在设计API的Body请求体或返回响应时,如果需要使用某种数据模型、公共响应等,可直接引用对应的公共模型,单击“公共模型”搜索框右侧,新建不同类型公共模型,CodeArts API提供以下7种公共模型定义:数据模型、公共响应、公共参数
产品功能 表1 CodeArts API服务功能概览 功能名称 功能描述 API设计 通过表单编辑和Swagger原生编辑器设计API,并利用API规范检查保证API设计质量。 API文档 自动生成API使用文档,支持API文档快速索引。 API开发 自动生成API前端SDK和后端框架代码
公共模型 公共模型提供API设计时所需公共数据的定义,在设计API的Body请求体或返回响应时,如果需要使用某种数据模型、公共响应等,可直接引用对应的公共模型,单击“公共模型”搜索框右侧,新建不同类型公共模型,CodeArts API提供以下7种公共模型定义:数据模型、公共响应、公共参数
功能总览 功能总览 全部 API设计 API Mock API测试 API管理运维 API设计 API设计和API文档100%一致,所写即所得,以使用者视角定义API。 一键新建API、Markdown,Swagger标准文件一键导入。 Swagger 原生&结构表单API可视化编辑