# CodeArts API


## 产品介绍

- [什么是CodeArts API](https://support.huaweicloud.com/productdesc-apiarts/apiarts_07_0001.md): CodeArts API是华为云API全生命周期管理一体化协作平台，支持开发者高效实现API设计、API开发、API测试、API托管、API运维、API变现的一站式体验。通过以API契约为锚点，CodeArts API保证API各阶段数据高度一致，为开发者提供友好易用的API全流程端到端解决方案。借助CodeArts API，开发者可以高
- [API管理痛点](https://support.huaweicloud.com/productdesc-apiarts/zh-cn_topic_0000001818900045.md): 传统的API全生命周期管理方案，研发团队通常会使用多种工具管理API：Swagger：设计与管理API文档Postman：API调试工具Mockjs：Mock API数据JMeter：API自动化测试工具因此，在传统的研发流程中，开发者常常面对以下繁琐的协作场景：一个项目可能有多个设计者，设计者通常根据以往的经验或者模仿已有的API样例做
- [产品优势](https://support.huaweicloud.com/productdesc-apiarts/apiarts_07_0002.md): API设计、开发、测试等关键开发流程一站式协同。API托管、运维、变现等运营流程一体化协同。API全流程数据自动同步。支持表单可视化编辑设计API。支持Swagger编辑器原生开发者体验。API设计和API文档 100% 一致，所写即所得，以使用者视角定义API。基于华为10年API治理经验，嵌入国内唯一“先进级”评级的API全生命周期管
- [应用场景](https://support.huaweicloud.com/productdesc-apiarts/apiarts_07_0003.md): CodeArts API面向开发者提供API全生命周期管理的最佳实践。CodeArts API既可以帮助个人开发者一站式管理运营自己的API，摆脱工具、环境的束缚，快速实现API资产变现；也可以帮助企业规范化API流程，端到端提升设计、开发、测试、运维、运营等各组织的配合效率。
- [产品功能](https://support.huaweicloud.com/productdesc-apiarts/apiarts_07_0004.md): CodeArts API服务支持的主要功能如下。关于各功能支持的地域（Region）信息，可通过控制台查询详情。API设计和API文档100%一致，所写即所得，以使用者视角定义API。一键新建API、Markdown，Swagger标准文件一键导入。Swagger 原生&结构表单API可视化编辑，专业API规范性自动化检查，设计问题辅助修
- [计费说明](https://support.huaweicloud.com/productdesc-apiarts/apiarts_07_0006.md): CodeArts API属于开发者生态工具，使用华为云码道的套餐计费规则，用户可以登录CodeArts控制台购买套餐。CodeArts API将“快捷调试”，“API设计”，“API Mock”，“API发布”等特性免费开放给所有开发者，用户仅需要开通“CodeArts体验版”套餐，即可免费使用CodeArts API服务，限制人数50人
- [发布历史](https://support.huaweicloud.com/productdesc-apiarts/apiarts_07_0005.md): 记录了客户端版本发布历史，包括新特性、问题修复及优化等内容，用户可以在该页面下载最新版本客户端。
- [权限管理](https://support.huaweicloud.com/productdesc-apiarts/zh-cn_topic_0000001391035028.md): 如果您需要对华为云上购买的CodeArts API资源，为企业中的员工设置不同的访问权限，以达到不同员工之间的权限隔离，您可以使用统一身份认证服务（Identity and Access Management，简称IAM）进行精细的权限管理。该服务提供用户身份认证、权限分配、访问控制等功能，可以帮助您安全的控制华为云资源的访问。如果华为账

## 快速入门

- [快速入门](https://support.huaweicloud.com/qs-apiarts/zh-cn_topic_0000001796407160.md): 使用华为云账号登录CodeArts API，系统默认为新用户新建“示例项目”并进入项目，用户可基于“示例项目”进行快捷调试。进入项目后，单击搜索框旁，可根据需要选择“新建快捷调试”或“导入Postman文件”进行快捷调试。新建快捷调试单击“新建快捷调试”，生成“快捷调试”页签。输入接口完整URL，单击“发送”即可对已有接口进行快捷调试。P

## 用户指南

- [浏览器访问](https://support.huaweicloud.com/usermanual-apiarts/apiarts_01_0066.md): 访问CodeArts API产品官网首页，单击“网页版体验”，填写华为云账户密码进行登录，进入CodeArts API首页。首次登录CodeArts API服务，系统将为用户默认创建示例项目，并进入项目，用户可基于项目中的示例接口认识API相关概念并熟悉产品使用方法。CodeArts API Web版本需要安装浏览器扩展，通过浏览器扩展发
- [下载CodeArts API客户端](https://support.huaweicloud.com/usermanual-apiarts/apiarts_01_0077.md): Windows 平台提供了桌面应用程序，可下载客户端，下载完成后解压文件，运行解压文件即可安装 CodeArts API 到您的电脑。CodeArts API客户端下载地址如下表所示。CodeArts API客户端下载地址是不带sha256后缀结尾的链接，带sha256后缀结尾的下载链接仅为对应软件包的完整性校验文件。例如：客户端的下载链
- [访问客户端](https://support.huaweicloud.com/usermanual-apiarts/apiarts_01_0071.md): 客户端支持登录和未登录使用。导入与导出功能需要登录后才可以继续使用。前置脚本、后置脚本功能需要登录后才可继续使用。单击“登录/注册”，填写华为云账户密码进行登录。首次登录CodeArts API服务，系统将为用户默认创建示例项目，并进入项目，用户可基于项目中的示例接口认识API相关概念并熟悉产品使用方法。打开客户端，在登录页面单击“稍后再
- [全局代理](https://support.huaweicloud.com/usermanual-apiarts/apiarts_01_0023.md): CodeArts API客户端版本支持设置全局网络代理，设置后，代理应用于所有联网服务，包括连接CodeArts API服务器和发送接口请求。使用系统代理进入网络代理设置页面后，默认使用系统代理。可根据需要选择是否优先使用系统环境变量HTTP_PROXY、HTTPS_PROXY、NO_PROXY，勾选后，CodeArts API会优先调用
- [通过IAM角色或策略授予使用CodeArts API的权限](https://support.huaweicloud.com/usermanual-apiarts/apiarts_01_0080.md): 如果您需要对您所拥有的CodeArts API进行角色与策略的权限管理，您可以使用统一身份认证服务（Identity and Access Management，简称IAM），通过IAM，您可以：根据企业的业务组织，在您的华为账号中，给企业中不同职能部门的员工创建IAM用户，让员工拥有唯一安全凭证，并使用CodeArts API资源。根据
- [通过IAM身份策略授予使用CodeArts API的权限](https://support.huaweicloud.com/usermanual-apiarts/apiarts_01_0081.md): 如果您需要对您所拥有的CodeArts API进行身份策略的权限管理，您可以使用统一身份认证服务（Identity and Access Management，简称IAM），通过IAM，您可以：根据企业的业务组织，在您的华为账号中，给企业中不同职能部门的员工创建用户或用户组，让员工拥有唯一安全凭证，并使用CodeArts API资源。根据
- [授权企业联邦账号使用CodeArts API](https://support.huaweicloud.com/usermanual-apiarts/apiarts_01_0083.md): 支持授权企业联邦账号使用CodeArts API。虚拟用户SSO需要先登录一次CodeArts API，项目拥有者/项目经理才可以在成员管理页面中查询并添加该用户。支持企业联邦账号登录并使用网页版CodeArts API，客户端暂不支持。提供企业账户授权的启用、停用等操作。通过增加企业账户授权，您可以开放本企业账户的资源的使用权限给其他企
- [权限和授权项说明](https://support.huaweicloud.com/usermanual-apiarts/apiarts_01_0085.md): 如果您需要对您所拥有的CodeArts API进行精细的权限管理，您可以使用统一身份认证服务（Identity and Access Management，简称IAM），如果华为账号所具备的权限功能已经能满足您的要求，您可以跳过本章节，不影响您使用CodeArts API服务的其他功能。通过IAM，您可以通过授权控制主体（IAM用户、用户
- [身份策略授权参考](https://support.huaweicloud.com/usermanual-apiarts/apiarts_01_0086.md): 云服务在IAM预置了常用的权限，称为系统身份策略。如果IAM系统身份策略无法满足授权要求，管理员可以根据各服务支持的授权项，创建IAM自定义身份策略来进行精细的访问控制，IAM自定义身份策略是对系统身份策略的扩展和补充。除IAM服务外，Organizations服务中的服务控制策略（Service Control Policy，以下简称S
- [创建、管理项目](https://support.huaweicloud.com/usermanual-apiarts/apiarts_01_0019.md): 拥有创建项目权限的用户可以在CodeArts API的控制台创建新的项目。登录CodeArts API控制台，单击“创建项目”，弹出“创建项目”窗口。填写项目基本信息。新建项目参数说明字段名称是否必填备注说明项目名称是项目名称，限制128个字符。项目描述否项目描述，限制1024个字符。单击“确定”，完成项目创建。CodeArts API还
- [管理成员与角色](https://support.huaweicloud.com/usermanual-apiarts/apiarts_01_0074.md): 项目创建完成后，当用户需要团队协作来完成这个项目时，可以邀请同一个华为云账号下的其他IAM用户加入项目，并给成员分配角色。拥有“通用设置”->“项目”的编辑权限。拥有“通用设置”->“角色”->“成员设置”权限，可以添加成员或将成员移出项目。拥有“通用设置”->“角色”->“权限设置”权限，可以给成员分配角色。项目创建者拥有所有的权限。单
- [管理角色权限](https://support.huaweicloud.com/usermanual-apiarts/apiarts_01_0021.md): 为项目各个角色设置不同操作权限，包括项目基本信息的编辑和归档、角色及权限的设置和成员设置，还可以根据需要自定义角色类型并授权。单击项目名称，进入目标项目，单击“项目设置>权限管理>权限”，进入权限管理页面。选择左侧角色名称，在右侧单击“编辑”可为角色勾选设置不同操作权限。仅项目管理员的操作权限不支持修改。仅项目管理员的操作权限不支持修改。
- [角色与操作权限说明](https://support.huaweicloud.com/usermanual-apiarts/apiarts_01_0075.md): CodeArts API服务各用户角色类型及对应的操作权限说明如下：表1 通用设置默认角色权限说明表2 API测试默认角色权限说明表3 项目资源默认角色权限说明
- [项目概况](https://support.huaweicloud.com/usermanual-apiarts/apiarts_01_0078.md): 进入CodeArts API目标项目后，默认进入项目概况页面，可查看项目下数据统计及API集合情况。
- [API设计](https://support.huaweicloud.com/usermanual-apiarts/apiarts_01_0002.md): API（应用程序编程接口）设计是API全生命周期的第一步，其含义是通过规定接口的路径、所属目录、Tag、请求参数、请求体等来定义接口，从而帮助开发人员在沟通中对某一接口有着同样、确定的定义。进入CodeArts API目标项目后，单击左侧搜索框旁边的，选择下拉选项中的“新建API接口”，创建http类型接口。接口文档应针对以下要素进行设计
- [审核设置](https://support.huaweicloud.com/usermanual-apiarts/apiarts_01_0054.md): API设计审核为用户提供了一套成熟的审核流程，帮助检查项目中设计的API接口是否符合需求。项目经理和项目创建者有审核设置权限。单击“项目设置 > 功能设置”，进入“功能设置”页面。在“审核设置”页签，审核设置按钮默认为关闭状态，单击，开启审核功能。开启审核功能后，在项目下API设计中创建、删除、修改API的操作均会被记录为草稿内容，需要通
- [提交审核](https://support.huaweicloud.com/usermanual-apiarts/apiarts_01_0055.md): 审核功能开启后，对于API接口的操作都需要提交审核并通过后才可生效。审核流程结束前，提交审核的API接口将处于锁定状态，不可编辑和删除。当进行新增、修改、删除API接口的操作后，接口列表会出现相应提示图标。单击变更的API接口，在API“文档”页面单击“变更对比”。弹出“变更对比”页面，可查看API接口变更前后的对比详情。其他项目参与者有
- [接口审核](https://support.huaweicloud.com/usermanual-apiarts/apiarts_01_0056.md): API审核操作用户角色类型及操作权限说明如下：单击，弹出“接口审核”页面，默认可查看项目中所有“待审核”状态的API接口列表。单击操作列的，弹出“审核详情”页面，可查看API接口变更前后的对比详情。填写“审核意见”，单击“通过”或“拒绝”，完成API接口的审核。对于已提交审核的API接口，提交人员可通过进入“接口审核”页面进行撤回审核的操
- [编辑模式与API规范检查](https://support.huaweicloud.com/usermanual-apiarts/apiarts_01_0024.md): CodeArts API在API设计界面提供代码编辑模式进行API设计，可使用yaml格式设计接口文档。在编辑模式中CodeArts API提供API规范性检查。通过规范性检查功能，可以形成统一的设计规范，避免API设计不一致，提高API设计质量。API规范设计定义，请参照设置API设计规范。编辑模式规范性检查单击项目名称，进入目标项目，
- [公共模型](https://support.huaweicloud.com/usermanual-apiarts/apiarts_01_0025.md): 公共模型提供API设计时所需公共数据的定义，在设计API的Body请求体或返回响应时，如果需要使用某种数据模型、公共响应等，可直接引用对应的公共模型，单击“公共模型”搜索框右侧，新建不同类型公共模型，CodeArts API提供以下7种公共模型定义：数据模型、公共响应、公共参数、公共请求体、公共示例、安全模型、公共响应头。数据模型和编程语
- [Markdown设计](https://support.huaweicloud.com/usermanual-apiarts/apiarts_01_0004.md): Markdown文件只能在同一根目录下进行移动。处于编辑页面的Markdown文件不能移动。方法一：单击目录树搜索框右侧的，在弹出的下拉框中，选择“新建Markdown”。方法二：在目录树中选择一个目录，单击右侧图标，在弹出的下拉框中，选择“新建Markdown”。目录：在上一步中，如果通过方法一和方法二新建Markdown，目录初始内容
- [API调试](https://support.huaweicloud.com/usermanual-apiarts/apiarts_01_0003.md): 完成API设计之后，在API文档页面单击“运行”会自动切换到API调试页面，也可以单击“调试”页签切换到API调试页面，本节介绍调试页面相关信息配置。由于浏览器限制，使用CodeArts API的Web版本进行接口调试，需要先安装浏览器扩展，浏览器扩展请查看浏览器扩展。API调试页面的接口路径，可以选择http或https，并在定义的路径
- [执行流程](https://support.huaweicloud.com/usermanual-apiarts/apiarts_01_0027.md): CodeArts API提供基于JavaScript的脚本引入，通过脚本可以实现在快捷调试或接口请求时添加动态行为。脚本执行流程如图：CodeArts API兼容Postman脚本语法，可以将Postman脚本迁移到CodeArts API中使用。CodeArts API脚本能力仅限于快捷调试、接口调试、接口调试用例。接口的前置脚本与后置
- [前置脚本](https://support.huaweicloud.com/usermanual-apiarts/apiarts_01_0028.md): 前置脚本是在请求发送前执行的代码片段。例如需要在请求头中生成时间戳、打印日志、设置随机参数值等。可以在接口的“前置脚本”页面中单击“添加前置操作 > 自定义脚本”，发送接口请求前将自动运行前置脚本。可以通过“console.log()”将需要的变量打印在控制台，用以查看某个变量的当前值。可以通过脚本对环境变量和临时变量进行特定操作，此类操
- [后置脚本](https://support.huaweicloud.com/usermanual-apiarts/apiarts_01_0029.md): 后置脚本是在请求发送后执行的代码片段，主要用于验证请求返回的结果（断言）、将请求返回的结果数据写入环境变量等场景。可以在接口的“后置脚本”页面中单击“添加后置操作”，发送接口请求后将自动运行后置脚本。可以利用后置脚本验证API响应返回结果的正确性。后置脚本与前置脚本具备相同能力，包括：打印日志、操作变量、发送请求、编写并执行复杂的JS函数
- [pm对象API参考](https://support.huaweicloud.com/usermanual-apiarts/apiarts_01_0030.md): pm:Objectpm对象，含有接口运行关联信息。可利用它获取或设置环境变量和全局变量，且访问请求信息和返回结果信息。pm:info:Objectpm.info对象，含有接口运行关联信息。pm.info.eventName:String：获取当前执行的脚本类型：前置脚本（prerequest），后置脚本（test）。pm.info.ite
- [使用JS类库](https://support.huaweicloud.com/usermanual-apiarts/apiarts_01_0031.md): 断言chai （v4.2.0）：用于断言BDD/TDD断言。chai （v4.2.0）：用于断言BDD/TDD断言。加密解密库jsrsasign（10.3.0）：用于RSA加密/解密。Encode、Decode 库crypto-js（v3.1.9-1）：编码/解码库，基本包含常用的编码、解码方式，如Base64、MD5、SHA、HMAC、
- [导入项目](https://support.huaweicloud.com/usermanual-apiarts/apiarts_01_0038.md): CodeArts API提供友商项目导入功能，目前支持API Fox项目及YApi项目中的API设计导入CodeArts API中。导出数据打开API Fox对应项目，单击“项目设置 > 导出数据”，进入“导出数据”页面。选择“Apifox”数据格式，单击”导出”，完成导出。打开API Fox对应项目，单击“项目设置 > 导出数据”，进入
- [导入快捷调试](https://support.huaweicloud.com/usermanual-apiarts/apiarts_01_0057.md): CodeArts API支持Postman的Collection数据文件的导入，也支持Collections和Environments数据集ZIP包的全量导入，方便用户迁移调试数据。进入“快捷调试”页面，单击，选择“导入Postman文件”。弹出“导入Postman文件”对话框，选择需要导入的Postman文件。Collection数据文
- [导入接口](https://support.huaweicloud.com/usermanual-apiarts/apiarts_01_0033.md): CodeArts API支持导入以下API数据格式文件，方便数据迁移。SwaggerPostman（支持Collections和Environment数据集ZIP包）JmeterSwagger URL导入文件时，一个文件导入后，将会视为一个根目录，一个根目录中不允许存在URL相同的接口。可通过以下两种入口导入数据。入口一单击“项目设置 >
- [定时导入接口](https://support.huaweicloud.com/usermanual-apiarts/apiarts_01_0076.md): CodeArts API支持执行定时任务来导入API接口。单击“项目设置 > 导入数据”，单击“定时导入”页签。单击“新建”，弹出“新增定时任务”窗口。配置任务参数，参数配置请参考下表。参数配置说明任务名称定时任务名称，只允许输入字母、汉字、数字、下划线、中划线，长度3-64个字符。数据源格式支持OpenApi格式。数据源URL数据源UR
- [导出接口](https://support.huaweicloud.com/usermanual-apiarts/apiarts_01_0034.md): CodeArts API支持将接口导出为多种数据格式，可通过以下两种入口导出数据。入口一单击接口目录或接口功能目录名称右侧，选择“导出”，可以导出OpenAPI 3.0、Swagger 2.0版本格式的接口文件，且文件格式支持Yaml、Json、Html。在弹出的“导出”窗口中，选择需要导出的数据格式及接口，单击“导出”。入口二单击“项目
- [推送接口](https://support.huaweicloud.com/usermanual-apiarts/apiarts_01_0079.md): CodeArts API支持将设计完成的接口推送至第三方URL。单击“项目设置 > 导出数据”，单击“第三方推送”页签。单击“新建”，弹出“新增同步任务”窗口。配置任务参数，参数配置请参考下表。参数配置说明任务名称同步任务名称，只允许输入字母、汉字、数字、下划线、中划线，长度3-64个字符。数据源格式支持OpenAPI 3.0、Swagg
- [环境与环境变量](https://support.huaweicloud.com/usermanual-apiarts/apiarts_01_0035.md): 在开发项目中，不同阶段对应不同环境，例如：前端与后端的开发人员需要在研发环境做功能联调，测试人员需要在测试环境测试，上线生产环境前也需要在预发环境验证，不同环境对应不同的前置URL和接口参数值，为了方便快速切换运行环境，快速修改前置URL等参数，CodeArts API提供了环境管理功能。免费开通“API测试”的高阶功能试用或开通Code
- [API开发](https://support.huaweicloud.com/usermanual-apiarts/apiarts_01_0036.md): CodeArts API支持生成接口请求代码和业务代码，缩短前后端开发时长，规范代码结构。基于接口定义，CodeArts API支持自动生成各种语言和框架的请求代码和业务代码。在API设计模块，接口文档界面右侧，即可看到“生成代码”的入口。生成接口请求代码单击“生成代码”下拉框，选择“生成接口请求代码”，弹出“生成接口请求代码”对话框。支
- [背景介绍](https://support.huaweicloud.com/usermanual-apiarts/apiarts_01_0006.md): 随着微服务系统及分布式架构的发展，多模块或子系统的依赖为软件系统的开发与测试带来了很多挑战。比如在测试某个模块时，依赖的第三方服务不能返回想要的结果，或第三方服务不稳定时，该模块的测试进度则会受到影响。Mock服务能很好解决这些问题，使用场景如下：并行开发：在被依赖模块未开发完成时，使用Mock服务替代真实业务服务场景，可进行并行开发。依
- [Mock规则管理](https://support.huaweicloud.com/usermanual-apiarts/apiarts_01_0007.md): 可通过以下操作步骤进入目录级Mock规则管理页面或接口级高级Mock页面。目录级Mock规则管理页面单击“API设计”，然后单击接口目录右侧的，选择“Mock规则管理”。进入“Mock规则管理”页面，可以查看当前目录下所有接口和接口对应的Mock规则。单击“API设计”，然后单击接口目录右侧的，选择“Mock规则管理”。进入“Mock规则
- [Mock规则设计](https://support.huaweicloud.com/usermanual-apiarts/apiarts_01_0008.md): 请求Mock服务时，系统会根据规则中配置的参数匹配，只有规则下所有参数满足匹配条件时，才可匹配到整个规则。请求参数，支持Query、Path、Header、Body。Path参数只有在当前选择的接口的url中存在path变量时才可以显示配置。Path参数只有在当前选择的接口的url中存在path变量时才可以显示配置。Body支持json和
- [Mock语法说明](https://support.huaweicloud.com/usermanual-apiarts/apiarts_01_0009.md): APIMock语法完全兼容Mock.js，并扩展了一些Mock.js没有的语法（uuid、正则表达式），Mock语法详见表1。如现有Mock语法无法满足需求，建议使用正则表达式“@regexp”来实现灵活定制，正则表达式基本能满足各种特殊场景的需求。使用正则表达式时，“regexp”特殊字符需要加上“\”进行转义。支持json。函数需要写
- [设置Mock](https://support.huaweicloud.com/usermanual-apiarts/apiarts_01_0072.md): 默认开启云端Mock，云端Mock功能适用于团队的共同协作场景，提供一个固定地址，其他成员可以通过这个地址访问云端Mock Server。云端Mock的优势：Mock数据统一管理配置数据团队共享单击项目名称，进入目标项目，单击“项目设置 > 功能设置”，默认选择Mock设置页签，选择“开放访问”或“Token鉴权”，即可设置云端Mock访
- [API测试导读](https://support.huaweicloud.com/usermanual-apiarts/apiarts_01_0039.md): CodeArts API的“API测试”功能来源于CodeArts TestPlan的“接口自动化测试”能力，且与CodeArts TestPlan的数据同源。CodeArts API针对API做测试，更贴近API的设计、开发到测试的同步场景。CodeArts TestPlan对整个项目做整体的测试计划与测试方案，更偏向测试场景使用。接口
- [新建测试用例](https://support.huaweicloud.com/usermanual-apiarts/apiarts_01_0041.md): 单击“API测试”菜单，进入测试用例管理主页面，可通过以下两种入口新建测试用例。入口一：单击主页面的“新建测试用例”选项。入口二：单击左侧测试用例旁边的，选择下拉选项中的“新建测试用例”选项。入口一：单击主页面的“新建测试用例”选项。入口二：单击左侧测试用例旁边的，选择下拉选项中的“新建测试用例”选项。进入“新建测试用例”页面，输入测试用
- [添加测试步骤](https://support.huaweicloud.com/usermanual-apiarts/apiarts_01_0042.md): 接口自动化测试用例可包括三个阶段：准备阶段、测试阶段、销毁阶段。准备阶段对应的“前置步骤”，即测试的前置准备条件；测试阶段对应“测试步骤”，实现接口的功能测试；销毁阶段对应“后置步骤”，实现准备阶段和测试阶段数据的释放或恢复，保证测试用例可重复执行。准备阶段（可选）：前置步骤。在此阶段中准备测试阶段需要的前置条件数据，如果没有前置条件，可
- [关键字库](https://support.huaweicloud.com/usermanual-apiarts/apiarts_01_0043.md): 关键字驱动测试是一种测试自动化的技术，通过提供一组称为关键字的“构建块”创建自动化测试用例。关键字驱动测试可用于组件测试、系统测试等不同级别的测试，其优势体现在易用性、可理解性、可维护性、测试信息的重用、支持测试自动化、节约潜在的成本和进度等方面。在设计测试用例时，经常会遇到一些相同的前置步骤或者测试逻辑。如果每一个测试用例中都编写这些步
- [响应提取](https://support.huaweicloud.com/usermanual-apiarts/apiarts_01_0044.md): 响应提取是提取接口响应结果的某一部分，命名为参数，供后续测试步骤参数化调用。响应提取需要在前序测试步骤定义，后续测试步骤使用。在前序测试步骤中，在“响应提取”页签创建要传递的参数。响应提取来源用到内置参数，请参考内置参数了解如何使用内置参数。响应提取同时支持正则表达式的匹配，提取出与给定正则表达式匹配的返回值。在后续测试步骤中，通过“${
- [测试流程控制条件](https://support.huaweicloud.com/usermanual-apiarts/apiarts_01_0045.md): 在测试用例中，可能会有复杂的测试场景，因此CodeArts API提供了多种流程控制条件：循环、判断、分组、等待时间。当测试步骤需要重复执行时，可以指定重复执行次数。进入接口自动化用例编辑的“脚本”页签，单击“循环”。设置循环次数。循环中可添加URL请求、判断、分组、等待、测试关键字。如果需要根据前序测试步骤的结果决定后续需要执行的测试步
- [测试检查点](https://support.huaweicloud.com/usermanual-apiarts/apiarts_01_0046.md): 在测试步骤请求中可以设置请求结果的检查点，方便用户检测当前接口的返回值，验证测试步骤是否得到预期结果。推荐用户设置检查点。针对接口类请求，请提供判断响应码的检查点。当检查点设置为空，不论接口的响应码是什么，都会判断结果为成功。测试检查点即请求结果的断言，通过检查接口响应是否符合预期，判定系统是否满足预期。在接口自动化用例中，测试步骤的“检
- [环境&参数](https://support.huaweicloud.com/usermanual-apiarts/apiarts_01_0047.md): 在自动化测试中，通常存在多个测试环境，每个测试环境的环境参数值会有不同，例如域名、账号等。这些参数常会在测试脚本中被使用到，如果将这些参数硬绑定到测试脚本中，脚本的冗余度很高，复用度很低。合理的测试设计要求分离测试逻辑和测试数据，实现测试逻辑的最大化复用，增强测试用例的可维护性和投入产出比。例如不同测试环境的URL域名是一种独立于测试逻辑
- [运行&报告](https://support.huaweicloud.com/usermanual-apiarts/apiarts_01_0048.md): 在“测试用例”页面，单击“调试”，开始执行测试用例。调试完成后，可查看用例运行结果。以下图结果记录为例，可快速查看具体用例执行成功或失败的执行用时。单击单条结果记录，可查看执行的详细信息。
- [测试文件夹管理](https://support.huaweicloud.com/usermanual-apiarts/apiarts_01_0049.md): 单击测试用例的任意文件夹，可以查看文件夹下面的全部测试用例。单击用例操作列的，可快捷执行测试用例。单击用例操作列的，可快捷查看测试用例执行历史。单击用例操作列的，可单击“复制”或“删除”测试用例。全选测试用例，单击“删除”，可批量删除测试用例。
- [创建测试套件](https://support.huaweicloud.com/usermanual-apiarts/apiarts_01_0051.md): 自动化测试套件，实现用例串行/并行执行的策略，测试用例分块加速能力，有效提高资源池利用率，减少任务阻塞情况。并且可提前拦截产品缺陷，更加快速地发现问题。可通过以下两种入口新建测试套件。入口一：单击主页面的“新建测试套件”选项。入口二：单击左侧测试用例旁边的，选择下拉选项中的“新建测试套件”选项。入口一：单击主页面的“新建测试套件”选项。入
- [运行&报告](https://support.huaweicloud.com/usermanual-apiarts/apiarts_01_0052.md): 运行测试套件在待执行测试套件详情页面，单击“执行”，运行测试套件。在待执行测试套件详情页面，单击“执行”，运行测试套件。查看测试报告页面右侧可快速查看最近测试结果。单击测试结果的，可查看测试结果的运行报告。单击”更多执行历史”，可查看历史测试结果的运行报告。页面右侧可快速查看最近测试结果。单击测试结果的，可查看测试结果的运行报告。单击”更
- [API网关注册](https://support.huaweicloud.com/usermanual-apiarts/apiarts_01_0059.md): CodeArts API支持将状态为“已测完”或“已发布”的API注册到APIG网关实例，用户需要登录APIG实例，将已注册的API发布，API即可在APIG中正式生效。API从注册到发布的管理流程如下：在使用API网关注册功能前，用户需要先购买APIG实例。如果没有购买过APIG实例，可以在CodeArts API上通过以下操作步骤完成
- [插件管理](https://support.huaweicloud.com/usermanual-apiarts/apiarts_01_0022.md): 在插件管理页面中可以查看APIG和ROMA实例，还可以根据需要购买实例。单击项目名称，进入目标项目，单击“项目设置>插件管理”，进入“插件管理”页面。单击实例名称，可进入实例详情页面，查看实例详情。单击“购买运行时实例”旁的下拉框，选择“购买APIG实例”或者“购买ROMA实例”，根据界面提示购买相应实例，具体操作可参考购买APIG实例和
- [版本管理](https://support.huaweicloud.com/usermanual-apiarts/apiarts_01_0073.md): CodeArts API提供API设计版本管理功能，可在不同版本之间进行快速切换，也可对不同版本API接口进行直接对比。克隆成项目时，只支持API设计模块中的API接口设计克隆为新项目中API设计模块的接口设计，API测试模块暂不支持克隆当前API测试模块相关测试用例与测试套件。测试用例导入时，因存量版本未在API测试模块中被同步创建，不