检测到您已登录华为云国际站账号，为了您更好的体验，建议您访问国际站服务网站 https://www.huaweicloud.com/intl/zh-cn
不再显示此消息
检测到您已登录华为云国际站账号，为了您更好的体验，建议您访问国际站服务网站 https://www.huaweicloud.com/intl/zh-cn
不再显示此消息
接口审核 角色权限 API审核操作用户角色类型及操作权限说明如下： 项目角色 操作 数据范围 项目创建者 查看 所有数据 审核 所有数据 撤回 自己提交的数据 项目经理 查看 所有数据 审核 所有数据 撤回 自己提交的数据 开发人员 查看 所有数据 撤回 自己提交的数据 操作步骤
定时导入接口 CodeArts API支持执行定时任务来导入API接口。 单击“项目设置 > 导入数据”，默认进入“定时导入”页签。 单击“新建”，弹出“新增定时任务”窗口。 配置任务参数，参数配置请参考下表。 参数 配置说明 任务名称 定时任务名称，只允许输入字母、汉字、数字、下划线、中划线，长度3-64个字符。
编辑模式与API规范检查 CodeArts API在API设计界面提供代码编辑模式进行API设计，可使用yaml格式设计接口文档。在编辑模式中CodeArts API提供API规范性检查。 通过规范性检查功能，可以形成统一的设计规范，避免API设计不一致，提高API设计质量。AP
下载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
环境与环境变量 在开发项目中，不同阶段对应不同环境，例如：前端与后端的开发人员需要在研发环境做功能联调，测试人员需要在测试环境测试，上线生产环境前也需要在预发环境验证，不同环境对应不同的前置URL和接口参数值，为了方便快速切换运行环境，快速修改前置URL等参数，CodeArts API提供了环境管理功能。
访问客户端 登录使用 单击“登录/注册”，填写华为云账户密码进行登录。 首次登录CodeArts API服务，系统将为用户默认创建示例项目，并进入项目，用户可基于项目中的示例接口认识API相关概念并熟悉产品使用方法。 未登录使用 打开客户端，在登录页面单击“稍后再说”即可开始使用
提交审核 审核功能开启后，对于API接口的操作都需要提交审核并通过后才可生效。 查看接口变更对比 当进行新增、修改、删除API接口的操作后，接口列表会出现相应提示图标。 单击变更的API接口，在API“文档”页面单击“变更对比”。 弹出“变更对比”页面，可查看API接口变更前后的对比详情。
API设计 API（应用程序编程接口）设计是API全生命周期的第一步，其含义是通过规定接口的路径、所属目录、Tag、请求参数、请求体等来定义接口，从而帮助开发人员在沟通中对某一接口有着同样、确定的定义。 新建API 进入CodeArts API目标项目后，单击左侧搜索框旁边的，选
环境与环境变量 在开发项目中，不同阶段对应不同环境，例如：前端与后端的开发人员需要在研发环境做功能联调，测试人员需要在测试环境测试，上线生产环境前也需要在预发环境验证，不同环境对应不同的前置URL和接口参数值，为了方便快速切换运行环境，快速修改前置URL等参数，CodeArts API提供了环境管理功能。
提交审核 审核功能开启后，对于API接口的操作都需要提交审核并通过后才可生效。 查看接口变更对比 当进行新增、修改、删除API接口的操作后，接口列表会出现相应提示图标。 单击变更的API接口，在API“文档”页面单击“变更对比”。 弹出“变更对比”页面，可查看API接口变更前后的对比详情。
API设计 API（应用程序编程接口）设计是API全生命周期的第一步，其含义是通过规定接口的路径、所属目录、Tag、请求参数、请求体等来定义接口，从而帮助开发人员在沟通中对某一接口有着同样、确定的定义。 新建API 进入CodeArts API目标项目后，单击左侧搜索框旁边的，选
访问客户端 登录使用 单击“登录/注册”，填写华为云账户密码进行登录。 首次登录CodeArts API服务，系统将为用户默认创建示例项目，并进入项目，用户可基于项目中的示例接口认识API相关概念并熟悉产品使用方法。 未登录使用 打开客户端，在登录页面单击“稍后再说”即可开始使用
添加测试步骤 接口自动化测试用例可包括三个阶段：准备阶段、测试阶段、销毁阶段。 准备阶段对应的“前置步骤”，即测试的前置准备条件；测试阶段对应“测试步骤”，实现接口的功能测试；销毁阶段对应“后置步骤”，实现准备阶段和测试阶段数据的释放或恢复，保证测试用例可重复执行。 准备阶段（可选）：前置步骤。
添加测试步骤 接口自动化测试用例可包括三个阶段：准备阶段、测试阶段、销毁阶段。 准备阶段对应的“前置步骤”，即测试的前置准备条件；测试阶段对应“测试步骤”，实现接口的功能测试；销毁阶段对应“后置步骤”，实现准备阶段和测试阶段数据的释放或恢复，保证测试用例可重复执行。 准备阶段（可选）：前置步骤。
快速入门 使用CodeArts API快速设计并调试接口 访问CodeArts API产品首页，单击“网页版体验”，首次使用华为云账号登录CodeArts API的用户，系统将默认为该用户新建“示例项目”并进入项目，用户可基于示例接口认识API相关概念并熟悉产品使用方法。 使用API设计
计费说明 CodeArts API属于开发者生态工具，使用软件开发生产线CodeArts的套餐计费规则，用户可以登录CodeArts控制台购买套餐。 CodeArts API将“快捷调试”，“API设计”，“API Mock”，“API发布”等特性免费开放给所有开发者，用户仅需要
None 产品介绍 CodeArts API 带您了解CodeArts API 02:34 介绍CodeArts API 操作指导 CodeArts API 介绍如何创建API设计及两种设计编辑模式 03:20 创建API设计 CodeArts API 介绍如何设置API设计规范
产品优势 API全流程高效协同 API设计、开发、测试等关键开发流程一站式协同。 API托管、运维、变现等运营流程一体化协同。 API全流程数据自动同步。 灵活API设计方式 支持表单可视化编辑设计API。 支持Swagger编辑器原生开发者体验。 API设计和API文档 100%
长按/截图保存，微信识别二维码
或者关注公众号“华为云”
