检测到您已登录华为云国际站账号，为了您更好的体验，建议您访问国际站服务网站 https://www.huaweicloud.com/intl/zh-cn
不再显示此消息
检测到您已登录华为云国际站账号，为了您更好的体验，建议您访问国际站服务网站 https://www.huaweicloud.com/intl/zh-cn
不再显示此消息
成长地图 | 华为云 CodeArts API CodeArts API是面向开发者，提供API设计、API开发、API文档、API调试、 API自动化测试一体化协作平台，通过维护API各开发阶段数据高度一致，支持开发者高效实现API设计、API开发、API测试一站式体验。 产品介绍
定时导入接口 CodeArts API支持执行定时任务来导入API接口。 单击“项目设置 > 导入数据”，默认进入“定时导入”页签。 单击“新建”，弹出“新增定时任务”窗口。 配置任务参数，参数配置请参考下表。 参数 配置说明 任务名称 定时任务名称，只允许输入字母、汉字、数字、下划线、中划线，长度3-64个字符。
下载CodeArts API客户端 Windows 平台提供了桌面应用程序，可下载客户端，下载完成后解压文件，运行解压文件即可安装 CodeArts API 到您的电脑。 CodeArts API客户端下载地址如下表所示。 支持平台 下载地址 Windows latest_win
定时导入接口 CodeArts API支持执行定时任务来导入API接口。 单击“项目设置 > 导入数据”，默认进入“定时导入”页签。 单击“新建”，弹出“新增定时任务”窗口。 配置任务参数，参数配置请参考下表。 参数 配置说明 任务名称 定时任务名称，只允许输入字母、汉字、数字、下划线、中划线，长度3-64个字符。
下载CodeArts API客户端 Windows 平台提供了桌面应用程序，可下载客户端，下载完成后解压文件，运行解压文件即可安装 CodeArts API 到您的电脑。 CodeArts API客户端下载地址如下表所示。 支持平台 下载地址 Windows latest_win
提交审核 审核功能开启后，对于API接口的操作都需要提交审核并通过后才可生效。 查看接口变更对比 当进行新增、修改、删除API接口的操作后，接口列表会出现相应提示图标。 单击变更的API接口，在API“文档”页面单击“变更对比”。 弹出“变更对比”页面，可查看API接口变更前后的对比详情。
提交审核 审核功能开启后，对于API接口的操作都需要提交审核并通过后才可生效。 约束与限制 审核流程结束前，提交审核的API接口将处于锁定状态，不可编辑和删除。 查看接口变更对比 当进行新增、修改、删除API接口的操作后，接口列表会出现相应提示图标。 单击变更的API接口，在API“文档”页面单击“变更对比”。
环境与环境变量 在开发项目中，不同阶段对应不同环境，例如：前端与后端的开发人员需要在研发环境做功能联调，测试人员需要在测试环境测试，上线生产环境前也需要在预发环境验证，不同环境对应不同的前置URL和接口参数值，为了方便快速切换运行环境，快速修改前置URL等参数，CodeArts API提供了环境管理功能。
环境与环境变量 在开发项目中，不同阶段对应不同环境，例如：前端与后端的开发人员需要在研发环境做功能联调，测试人员需要在测试环境测试，上线生产环境前也需要在预发环境验证，不同环境对应不同的前置URL和接口参数值，为了方便快速切换运行环境，快速修改前置URL等参数，CodeArts API提供了环境管理功能。
管理角色权限 为项目各个角色设置不同操作权限，包括项目基本信息的编辑和归档、角色及权限的设置和成员设置，还可以根据需要自定义角色类型并授权。 修改系统角色的权限 单击项目名称，进入目标项目，单击“项目设置 > 权限管理 > 权限”，进入权限管理页面。 选择左侧角色名称，在右侧单击“编辑”可为角色勾选设置不同操作权限。
Mock规则设计 配置请求规则 请求Mock服务时，系统会根据规则中配置的参数匹配，只有规则下所有参数满足匹配条件时，才可匹配到整个规则。 请求参数，支持Query、Path、Header、Body。 Path参数只有在当前选择的接口的url中存在path变量时才可以显示配置。
Mock规则设计 配置请求规则 请求Mock服务时，系统会根据规则中配置的参数匹配，只有规则下所有参数满足匹配条件时，才可匹配到整个规则。 请求参数，支持Query、Path、Header、Body。 Path参数只有在当前选择的接口的url中存在path变量时才可以显示配置。
管理角色权限 为项目各个角色设置不同操作权限，包括项目基本信息的编辑和归档、角色及权限的设置和成员设置，还可以根据需要自定义角色类型并授权。 修改系统角色的权限 单击项目名称，进入目标项目，单击“项目设置 > 权限管理 > 权限”，进入权限管理页面。 选择左侧角色名称，在右侧单击“编辑”可为角色勾选设置不同操作权限。
管理成员与角色 项目创建完成后，当用户需要团队协作来完成这个项目时，可以邀请同一个华为云账号下的其他IAM用户加入项目，并给成员分配角色。 前提条件 拥有“通用设置”->“项目”的编辑权限。 拥有“通用设置”->“角色”->“成员设置”权限，可以添加成员或将成员移出项目。 拥有“
快速入门 登录CodeArts API 使用华为云账号登录CodeArts API，系统默认为新用户新建“示例项目”并进入项目，用户可基于“示例项目”进行快捷调试。 新建快捷调试 进入项目后，单击搜索框旁，可根据需要选择“新建快捷调试”或“导入Postman文件”进行快捷调试。 新建快捷调试
管理成员与角色 项目创建完成后，当用户需要团队协作来完成这个项目时，可以邀请同一个华为云账号下的其他IAM用户加入项目，并给成员分配角色。 前提条件 拥有“通用设置”->“项目”的编辑权限。 拥有“通用设置”->“角色”->“成员设置”权限，可以添加成员或将成员移出项目。 拥有“
创建、管理项目 创建项目 拥有创建项目权限的用户可以在CodeArts API的控制台创建新的项目。 登录CodeArts API控制台，单击“创建项目”，弹出“创建项目”窗口。 填写项目基本信息。 表1 新建项目参数说明 字段名称 是否必填 备注说明 项目名称 是 项目名称，限制128个字符。
API调试 完成API设计之后，在API文档页面单击“运行”会自动切换到API调试页面，也可以单击“调试”页签切换到API调试页面，本节介绍调试页面相关信息配置。 由于浏览器限制，使用CodeArts API的Web版本进行接口调试，需要先安装浏览器扩展，浏览器扩展请查看浏览器扩展。
授权使用CodeArts API 支持授权IAM账号和企业联邦账号使用CodeArts API。 约束与限制 虚拟用户SSO需要先登录一次CodeArts API，项目拥有者/项目经理才可以在成员管理页面中查询并添加该用户。 支持企业联邦账号登录并使用网页版CodeArts API，客户端暂不支持。
创建、管理项目 创建项目 拥有创建项目权限的用户可以在CodeArts API的控制台创建新的项目。 登录CodeArts API控制台，单击“创建项目”，弹出“创建项目”窗口。 填写项目基本信息。 表1 新建项目参数说明 字段名称 是否必填 备注说明 项目名称 是 项目名称，限制128个字符。
长按/截图保存，微信识别二维码
或者关注公众号“华为云”
