检测到您已登录华为云国际站账号，为了您更好的体验，建议您访问国际站服务网站 https://www.huaweicloud.com/intl/zh-cn
不再显示此消息
检测到您已登录华为云国际站账号，为了您更好的体验，建议您访问国际站服务网站 https://www.huaweicloud.com/intl/zh-cn
不再显示此消息
Mock规则管理 规则入口 可通过以下操作步骤进入目录级Mock规则管理页面或接口级高级Mock页面。 目录级Mock规则管理页面 单击“API设计”，然后单击接口目录右侧的，选择“Mock规则管理”。 进入“Mock规则管理”页面，可以查看当前目录下所有接口和接口对应的Mock规则。
Mock规则设计 配置请求规则 请求Mock服务时，系统会根据规则中配置的参数匹配，只有规则下所有参数满足匹配条件时，才可匹配到整个规则。 请求参数，支持Query、Path、Header、Body。 Path参数只有在当前选择的接口的url中存在path变量时才可以显示配置。
Mock规则设计 配置请求规则 请求Mock服务时，系统会根据规则中配置的参数匹配，只有规则下所有参数满足匹配条件时，才可匹配到整个规则。 请求参数，支持Query、Path、Header、Body。 Path参数只有在当前选择的接口的url中存在path变量时才可以显示配置。
导入项目 CodeArts API提供友商项目导入功能，目前支持API Fox项目及YApi项目中的API设计导入CodeArts API中。 API Fox项目导入 导出数据 打开API Fox对应项目，单击“项目设置 > 导出数据”，进入“导出数据”页面。 选择“Apifox”数据格式，单击”导出”，完成导出。
设置Mock 默认开启云端Mock，云端Mock功能适用于团队的共同协作场景，提供一个固定地址，其他成员可以通过这个地址访问云端Mock Server。 云端Mock的优势： Mock数据统一管理 配置数据团队共享 单击项目名称，进入目标项目，单击“项目设置 > 功能设置”，默认
API支持将状态为“已测完”或“已发布”的API注册到APIG网关实例，用户需要登录APIG实例，将已注册的API发布，API即可在APIG中正式生效。 API从注册到发布的管理流程如下： 准备工作 在使用API网关注册功能前，用户需要先购买APIG实例。如果没有购买过APIG实例，可以在CodeArts
API支持将状态为“已测完”或“已发布”的API注册到APIG网关实例，用户需要登录APIG实例，将已注册的API发布，API即可在APIG中正式生效。 API从注册到发布的管理流程如下： 准备工作 在使用API网关注册功能前，用户需要先购买APIG实例。如果没有购买过APIG实例，可以在CodeArts
创建、管理项目 创建项目 拥有创建项目权限的用户可以在CodeArts API的控制台创建新的项目。 登录CodeArts API控制台，单击“创建项目”，弹出“创建项目”窗口。 填写项目基本信息。 表1 新建项目参数说明 字段名称 是否必填 备注说明 项目名称 是 项目名称，限制128个字符。
创建、管理项目 创建项目 拥有创建项目权限的用户可以在CodeArts API的控制台创建新的项目。 登录CodeArts API控制台，单击“创建项目”，弹出“创建项目”窗口。 填写项目基本信息。 表1 新建项目参数说明 字段名称 是否必填 备注说明 项目名称 是 项目名称，限制128个字符。
提交审核 审核功能开启后，对于API接口的操作都需要提交审核并通过后才可生效。 查看接口变更对比 当进行新增、修改、删除API接口的操作后，接口列表会出现相应提示图标。 单击变更的API接口，在API“文档”页面单击“变更对比”。 弹出“变更对比”页面，可查看API接口变更前后的对比详情。
提交审核 审核功能开启后，对于API接口的操作都需要提交审核并通过后才可生效。 查看接口变更对比 当进行新增、修改、删除API接口的操作后，接口列表会出现相应提示图标。 单击变更的API接口，在API“文档”页面单击“变更对比”。 弹出“变更对比”页面，可查看API接口变更前后的对比详情。
管理角色权限 为项目各个角色设置不同操作权限，包括项目基本信息的编辑和归档、角色及权限的设置和成员设置，还可以根据需要自定义角色类型并授权。 单击项目名称，进入目标项目，单击“项目设置 > 权限管理”，进入“权限管理”页面。 选择需要修改的角色名称和选项，在右侧勾选设置不同操作权限。
邀请其他企业用户 可以通过邀请其他企业用户，对当前项目进行查看或编辑。 单击“添加成员”旁的下拉框，选择“邀请其他企业用户”。 弹出“邀请其他企业用户”对话框，在“企业用户”输入框中输入企业用户ID，在“用户名称”输入框中输入需要邀请的用户名称后，单击右侧“添加用户”，可一次性添加同一企业不同用户。
后置脚本 后置脚本是在请求发送后执行的代码片段，主要用于验证请求返回的结果（断言）、将请求返回的结果数据写入环境变量等场景。可以在接口的“后置脚本”页面中单击“添加后置操作”，发送接口请求后将自动运行后置脚本。 断言 可以利用后置脚本验证API响应返回结果的正确性。 // 示例1：pm
后置脚本 后置脚本是在请求发送后执行的代码片段，主要用于验证请求返回的结果（断言）、将请求返回的结果数据写入环境变量等场景。可以在接口的“后置脚本”页面中单击“添加后置操作”，发送接口请求后将自动运行后置脚本。 断言 可以利用后置脚本验证API响应返回结果的正确性。 // 示例1：pm
导出接口 在接口目录或已设计好的接口功能目录中，可以导出OpenAPI 3.0、Swagger 2.0版本格式的接口文件，且文件格式支持Yaml、Json。 单击接口目录或接口功能目录名称右侧，选择“导出”。 在弹出的“导出”窗口中，选择需要导出的数据格式及接口，单击“导出”。 父主题：
编辑模式与API规范检查 CodeArts API在API设计界面提供代码编辑模式进行API设计，可使用yaml格式设计接口文档。在编辑模式中CodeArts API提供API规范性检查。 通过规范性检查功能，可以形成统一的设计规范，避免API设计不一致，提高API设计质量。AP
执行流程 CodeArts API提供基于JavaScript的脚本引入，通过脚本可以实现在快捷调试或接口请求时添加动态行为。脚本执行流程如图： CodeArts API兼容Postman脚本语法，可以将Postman脚本迁移到CodeArts API中使用。 CodeArts
导出接口 在接口目录或已设计好的接口功能目录中，可以导出OpenAPI 3.0、Swagger 2.0版本格式的接口文件，且文件格式支持Yaml、Json。 单击接口目录或接口功能目录名称右侧，选择“导出”。 在弹出的“导出”窗口中，选择需要导出的数据格式及接口，单击“导出”。 父主题：
管理项目成员与角色权限 管理成员与角色 管理角色权限 角色与操作权限说明 父主题： 使用CodeArts API服务
长按/截图保存，微信识别二维码
或者关注公众号“华为云”
