检测到您已登录华为云国际站账号，为了您更好的体验，建议您访问国际站服务网站 https://www.huaweicloud.com/intl/zh-cn
不再显示此消息
检测到您已登录华为云国际站账号，为了您更好的体验，建议您访问国际站服务网站 https://www.huaweicloud.com/intl/zh-cn
不再显示此消息
公共模型 公共模型提供API设计时所需公共数据的定义，在设计API的Body请求体或返回响应时，如果需要使用某种数据模型、公共响应等，可直接引用对应的公共模型，单击“公共模型”搜索框右侧，新建不同类型公共模型，CodeArts API提供以下7种公共模型定义：数据模型、公共响应、公共参数
Mock语法说明 APIMock语法完全兼容Mock.js，并扩展了一些Mock.js没有的语法（uuid、正则表达式），Mock语法详见表1。 如现有Mock语法无法满足需求，建议使用正则表达式“@regexp”来实现灵活定制，正则表达式基本能满足各种特殊场景的需求。 表1 Mock
Mock规则管理 规则入口 可通过以下操作步骤进入目录级Mock规则管理页面或接口级高级Mock页面。 目录级Mock规则管理页面 单击“API设计”，然后单击接口目录右侧的，选择“Mock规则管理”。 进入“Mock规则管理”页面，可以查看当前目录下所有接口和接口对应的Mock规则
背景介绍 随着微服务系统及分布式架构的发展，多模块或子系统的依赖为软件系统的开发与测试带来了很多挑战。比如在测试某个模块时，依赖的第三方服务不能返回想要的结果，或第三方服务不稳定时，该模块的测试进度则会受到影响。 Mock服务能很好解决这些问题，使用场景如下： 并行开发：在被依赖模块未开发完成时
公共模型 公共模型提供API设计时所需公共数据的定义，在设计API的Body请求体或返回响应时，如果需要使用某种数据模型、公共响应等，可直接引用对应的公共模型，单击“公共模型”搜索框右侧，新建不同类型公共模型，CodeArts API提供以下7种公共模型定义：数据模型、公共响应、公共参数
Markdown设计 约束与限制 Markdown文件只能在同一根目录下进行移动。 处于编辑页面的Markdown文件不能移动。 创建Markdown文件 新建Markdown，可通过以下三种方式完成。 方法一：单击目录树搜索框右侧的，在弹出的下拉框中，选择“新建Markdown”
全局代理 CodeArts API客户端版本支持设置全局网络代理，设置后，代理应用于所有联网服务，包括连接CodeArts API服务器和发送接口请求。 打开CodeArts API客户端后，单击右上角，进入设置页面。 单击“网络代理”，进入网络代理设置页面，可根据需要选择代理模式
项目概况 进入CodeArts API目标项目后，默认进入项目概况页面，可查看项目下数据统计及API集合情况。 父主题： API设计
项目概况 进入CodeArts API目标项目后，默认进入项目概况页面，可查看项目下数据统计及API集合情况。 父主题： API设计
设置Mock 默认开启云端Mock，云端Mock功能适用于团队的共同协作场景，提供一个固定地址，其他成员可以通过这个地址访问云端Mock Server。 云端Mock的优势： Mock数据统一管理 配置数据团队共享 单击项目名称，进入目标项目，单击“项目设置 > 功能设置”，默认选择
Mock规则管理 规则入口 可通过以下操作步骤进入目录级Mock规则管理页面或接口级高级Mock页面。 目录级Mock规则管理页面 单击“API设计”，然后单击接口目录右侧的，选择“Mock规则管理”。 进入“Mock规则管理”页面，可以查看当前目录下所有接口和接口对应的Mock规则
Mock规则设计 配置请求规则 请求Mock服务时，系统会根据规则中配置的参数匹配，只有规则下所有参数满足匹配条件时，才可匹配到整个规则。 请求参数，支持Query、Path、Header、Body。 Path参数只有在当前选择的接口的url中存在path变量时才可以显示配置。 Body
Mock语法说明 APIMock语法完全兼容Mock.js，并扩展了一些Mock.js没有的语法（uuid、正则表达式），Mock语法详见表1。 如现有Mock语法无法满足需求，建议使用正则表达式“@regexp”来实现灵活定制，正则表达式基本能满足各种特殊场景的需求。 表1 Mock
Mock规则设计 配置请求规则 请求Mock服务时，系统会根据规则中配置的参数匹配，只有规则下所有参数满足匹配条件时，才可匹配到整个规则。 请求参数，支持Query、Path、Header、Body。 Path参数只有在当前选择的接口的url中存在path变量时才可以显示配置。 Body
设置Mock 默认开启云端Mock，云端Mock功能适用于团队的共同协作场景，提供一个固定地址，其他成员可以通过这个地址访问云端Mock Server。 云端Mock的优势： Mock数据统一管理 配置数据团队共享 单击项目名称，进入目标项目，单击“项目设置 > 功能设置”，默认选择
全局代理 CodeArts API客户端版本支持设置全局网络代理，设置后，代理应用于所有联网服务，包括连接CodeArts API服务器和发送接口请求。 打开CodeArts API客户端后，单击右上角，进入设置页面。 单击“网络代理”，进入网络代理设置页面，可根据需要选择代理模式
前置脚本 前置脚本是在请求发送前执行的代码片段。例如需要在请求头中生成时间戳、打印日志、设置随机参数值等。可以在接口的“前置脚本”页面中单击“添加前置操作 > 自定义脚本”，发送接口请求前将自动运行前置脚本。 打印日志 可以通过“console.log()”将需要的变量打印在控制台
前置脚本 前置脚本是在请求发送前执行的代码片段。例如需要在请求头中生成时间戳、打印日志、设置随机参数值等。可以在接口的“前置脚本”页面中单击“添加前置操作 > 自定义脚本”，发送接口请求前将自动运行前置脚本。 打印日志 可以通过“console.log()”将需要的变量打印在控制台
审核设置 API设计审核为用户提供了一套成熟的审核流程，帮助检查项目中设计的API接口是否符合需求。 角色权限 项目经理和项目创建者有审核设置权限。 开启审核功能 单击“项目设置 > 功能设置”，进入“功能设置”页面。 在“审核设置”页签，审核设置按钮默认为关闭状态，单击，开启审核功能
提交审核 审核功能开启后，对于API接口的操作都需要提交审核并通过后才可生效。 查看接口变更对比 当进行新增、修改、删除API接口的操作后，接口列表会出现相应提示图标。 单击变更的API接口，在API“文档”页面单击“变更对比”。 弹出“变更对比”页面，可查看API接口变更前后的对比详情
长按/截图保存，微信识别二维码
或者关注公众号“华为云”
