检测到您已登录华为云国际站账号，为了您更好的体验，建议您访问国际站服务网站 https://www.huaweicloud.com/intl/zh-cn
不再显示此消息
检测到您已登录华为云国际站账号，为了您更好的体验，建议您访问国际站服务网站 https://www.huaweicloud.com/intl/zh-cn
不再显示此消息
版本管理 CodeArts API提供API设计版本管理功能，可在不同版本之间进行快速切换，也可对不同版本API接口进行直接对比。 创建版本 单击项目名称，进入目标项目，单击“项目设置 > 版本管理”，进入“版本管理”页面。 单击“新增版本”，填写版本号和描述，默认勾选“同步创建测试版本
版本管理 CodeArts API提供API设计版本管理功能，可在不同版本之间进行快速切换，也可对不同版本API接口进行直接对比。 约束与限制 克隆成项目时，只支持API设计模块中的API接口设计克隆为新项目中API设计模块的接口设计，API测试模块暂不支持克隆当前API测试模块相关测试用例与测试套件
背景介绍 随着微服务系统及分布式架构的发展，多模块或子系统的依赖为软件系统的开发与测试带来了很多挑战。比如在测试某个模块时，依赖的第三方服务不能返回想要的结果，或第三方服务不稳定时，该模块的测试进度则会受到影响。 Mock服务能很好解决这些问题，使用场景如下： 并行开发：在被依赖模块未开发完成时
公共模型 公共模型提供API设计时所需公共数据的定义，在设计API的Body请求体或返回响应时，如果需要使用某种数据模型、公共响应等，可直接引用对应的公共模型，单击“公共模型”搜索框右侧，新建不同类型公共模型，CodeArts API提供以下7种公共模型定义：数据模型、公共响应、公共参数
API设计 API（应用程序编程接口）设计是API全生命周期的第一步，其含义是通过规定接口的路径、所属目录、Tag、请求参数、请求体等来定义接口，从而帮助开发人员在沟通中对某一接口有着同样、确定的定义。 新建API 进入CodeArts API目标项目后，单击左侧搜索框旁边的，选择下拉选项中的
API调试 完成API设计之后，在API文档页面单击“运行”会自动切换到API调试页面，也可以单击“调试”页签切换到API调试页面，本节介绍调试页面相关信息配置。 约束与限制 由于浏览器限制，使用CodeArts API的Web版本进行接口调试，需要先安装浏览器扩展，浏览器扩展请查看浏览器扩展
Markdown设计 约束与限制 Markdown文件只能在同一根目录下进行移动。 处于编辑页面的Markdown文件不能移动。 创建Markdown文件 新建Markdown，可通过以下三种方式完成。 方法一：单击目录树搜索框右侧的，在弹出的下拉框中，选择“新建Markdown”
API调试 完成API设计之后，在API文档页面单击“运行”会自动切换到API调试页面，也可以单击“调试”页签切换到API调试页面，本节介绍调试页面相关信息配置。 由于浏览器限制，使用CodeArts API的Web版本进行接口调试，需要先安装浏览器扩展，浏览器扩展请查看浏览器扩展
项目概况 进入CodeArts API目标项目后，默认进入项目概况页面，可查看项目下数据统计及API集合情况。 父主题： API设计
项目概况 进入CodeArts API目标项目后，默认进入项目概况页面，可查看项目下数据统计及API集合情况。 父主题： API设计
API开发 CodeArts API支持生成接口请求代码和业务代码，缩短前后端开发时长，规范代码结构。 基于接口定义，CodeArts API支持自动生成各种语言和框架的请求代码和业务代码。在API设计模块，接口文档界面右侧，即可看到“生成代码”的入口。 生成接口请求代码 单击“生成代码
环境与环境变量 在开发项目中，不同阶段对应不同环境，例如：前端与后端的开发人员需要在研发环境做功能联调，测试人员需要在测试环境测试，上线生产环境前也需要在预发环境验证，不同环境对应不同的前置URL和接口参数值，为了方便快速切换运行环境，快速修改前置URL等参数，CodeArts API
设置Mock 默认开启云端Mock，云端Mock功能适用于团队的共同协作场景，提供一个固定地址，其他成员可以通过这个地址访问云端Mock Server。 云端Mock的优势： Mock数据统一管理 配置数据团队共享 单击项目名称，进入目标项目，单击“项目设置 > 功能设置”，默认选择
Mock规则管理 规则入口 可通过以下操作步骤进入目录级Mock规则管理页面或接口级高级Mock页面。 目录级Mock规则管理页面 单击“API设计”，然后单击接口目录右侧的，选择“Mock规则管理”。 进入“Mock规则管理”页面，可以查看当前目录下所有接口和接口对应的Mock规则
环境与环境变量 在开发项目中，不同阶段对应不同环境，例如：前端与后端的开发人员需要在研发环境做功能联调，测试人员需要在测试环境测试，上线生产环境前也需要在预发环境验证，不同环境对应不同的前置URL和接口参数值，为了方便快速切换运行环境，快速修改前置URL等参数，CodeArts API
Mock规则设计 配置请求规则 请求Mock服务时，系统会根据规则中配置的参数匹配，只有规则下所有参数满足匹配条件时，才可匹配到整个规则。 请求参数，支持Query、Path、Header、Body。 Path参数只有在当前选择的接口的url中存在path变量时才可以显示配置。 Body
API测试导读 API测试能力简介 CodeArts API的“API测试”功能来源于CodeArts TestPlan的“接口自动化测试”能力，且与CodeArts TestPlan的数据同源。 CodeArts API针对API做测试，更贴近API的设计、开发到测试的同步场景。
导入项目 CodeArts API提供友商项目导入功能，目前支持API Fox项目及YApi项目中的API设计导入CodeArts API中。 API Fox项目导入 导出数据 打开API Fox对应项目，单击“项目设置 > 导出数据”，进入“导出数据”页面。 选择“Apifox”
Mock语法说明 APIMock语法完全兼容Mock.js，并扩展了一些Mock.js没有的语法（uuid、正则表达式），Mock语法详见表1。 如现有Mock语法无法满足需求，建议使用正则表达式“@regexp”来实现灵活定制，正则表达式基本能满足各种特殊场景的需求。 表1 Mock
Mock规则设计 配置请求规则 请求Mock服务时，系统会根据规则中配置的参数匹配，只有规则下所有参数满足匹配条件时，才可匹配到整个规则。 请求参数，支持Query、Path、Header、Body。 Path参数只有在当前选择的接口的url中存在path变量时才可以显示配置。 Body
长按/截图保存，微信识别二维码
或者关注公众号“华为云”
