检测到您已登录华为云国际站账号，为了您更好的体验，建议您访问国际站服务网站 https://www.huaweicloud.com/intl/zh-cn
不再显示此消息
检测到您已登录华为云国际站账号，为了您更好的体验，建议您访问国际站服务网站 https://www.huaweicloud.com/intl/zh-cn
不再显示此消息
提交审核 审核功能开启后，对于API接口的操作都需要提交审核并通过后才可生效。 约束与限制 审核流程结束前，提交审核的API接口将处于锁定状态，不可编辑和删除。 查看接口变更对比 当进行新增、修改、删除API接口的操作后，接口列表会出现相应提示图标。 单击变更的API接口，在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
API测试导读 API测试能力简介 CodeArts API的“API测试”功能来源于CodeArts TestPlan的“接口自动化测试”能力，且与CodeArts TestPlan的数据同源。 CodeArts API针对API做测试，更贴近API的设计、开发到测试的同步场景。
设置Mock 默认开启云端Mock，云端Mock功能适用于团队的共同协作场景，提供一个固定地址，其他成员可以通过这个地址访问云端Mock Server。 云端Mock的优势： Mock数据统一管理 配置数据团队共享 单击项目名称，进入目标项目，单击“项目设置 > 功能设置”，默认选择
前置脚本 前置脚本是在请求发送前执行的代码片段。例如需要在请求头中生成时间戳、打印日志、设置随机参数值等。可以在接口的“前置脚本”页面中单击“添加前置操作 > 自定义脚本”，发送接口请求前将自动运行前置脚本。 打印日志 可以通过“console.log()”将需要的变量打印在控制台
前置脚本 前置脚本是在请求发送前执行的代码片段。例如需要在请求头中生成时间戳、打印日志、设置随机参数值等。可以在接口的“前置脚本”页面中单击“添加前置操作 > 自定义脚本”，发送接口请求前将自动运行前置脚本。 打印日志 可以通过“console.log()”将需要的变量打印在控制台
后置脚本 后置脚本是在请求发送后执行的代码片段，主要用于验证请求返回的结果（断言）、将请求返回的结果数据写入环境变量等场景。可以在接口的“后置脚本”页面中单击“添加后置操作”，发送接口请求后将自动运行后置脚本。 断言 可以利用后置脚本验证API响应返回结果的正确性。 // 示例1：
API网关注册 CodeArts API支持将状态为“已测完”或“已发布”的API注册到APIG网关实例，用户需要登录APIG实例，将已注册的API发布，API即可在APIG中正式生效。 API从注册到发布的管理流程如下： 准备工作 在使用API网关注册功能前，用户需要先购买APIG
接口审核 角色权限 API审核操作用户角色类型及操作权限说明如下： 项目角色 操作 数据范围 项目创建者 查看 所有数据 审核 所有数据 撤回 自己提交的数据 项目经理 查看 所有数据 审核 所有数据 撤回 自己提交的数据 开发人员 查看 所有数据 撤回 自己提交的数据 操作步骤
接口审核 角色权限 API审核操作用户角色类型及操作权限说明如下： 项目角色 操作 数据范围 项目创建者 查看 所有数据 审核 所有数据 撤回 自己提交的数据 项目经理 查看 所有数据 审核 所有数据 撤回 自己提交的数据 开发人员 查看 所有数据 撤回 自己提交的数据 操作步骤
导出接口 在接口目录或已设计好的接口功能目录中，可以导出OpenAPI 3.0、Swagger 2.0版本格式的接口文件，且文件格式支持Yaml、Json。 单击接口目录或接口功能目录名称右侧，选择“导出”。 在弹出的“导出”窗口中，选择需要导出的数据格式及接口，单击“导出”。 父主题
编辑模式与API规范检查 CodeArts API在API设计界面提供代码编辑模式进行API设计，可使用yaml格式设计接口文档。在编辑模式中CodeArts API提供API规范性检查。 通过规范性检查功能，可以形成统一的设计规范，避免API设计不一致，提高API设计质量。API
执行流程 CodeArts API提供基于JavaScript的脚本引入，通过脚本可以实现在快捷调试或接口请求时添加动态行为。脚本执行流程如图： CodeArts API兼容Postman脚本语法，可以将Postman脚本迁移到CodeArts API中使用。 CodeArts API
导出接口 在接口目录或已设计好的接口功能目录中，可以导出OpenAPI 3.0、Swagger 2.0版本格式的接口文件，且文件格式支持Yaml、Json、Html。 单击接口目录或接口功能目录名称右侧，选择“导出”。 在弹出的“导出”窗口中，选择需要导出的数据格式及接口，单击“导出
API网关注册 CodeArts API支持将状态为“已测完”或“已发布”的API注册到APIG网关实例，用户需要登录APIG实例，将已注册的API发布，API即可在APIG中正式生效。 API从注册到发布的管理流程如下： 准备工作 在使用API网关注册功能前，用户需要先购买APIG
后置脚本 后置脚本是在请求发送后执行的代码片段，主要用于验证请求返回的结果（断言）、将请求返回的结果数据写入环境变量等场景。可以在接口的“后置脚本”页面中单击“添加后置操作”，发送接口请求后将自动运行后置脚本。 断言 可以利用后置脚本验证API响应返回结果的正确性。 // 示例1：
长按/截图保存，微信识别二维码
或者关注公众号“华为云”
