检测到您已登录华为云国际站账号，为了您更好的体验，建议您访问国际站服务网站 https://www.huaweicloud.com/intl/zh-cn
不再显示此消息
检测到您已登录华为云国际站账号，为了您更好的体验，建议您访问国际站服务网站 https://www.huaweicloud.com/intl/zh-cn
不再显示此消息
环境与环境变量 在开发项目中，不同阶段对应不同环境，例如：前端与后端的开发人员需要在研发环境做功能联调，测试人员需要在测试环境测试，上线生产环境前也需要在预发环境验证，不同环境对应不同的前置URL和接口参数值，为了方便快速切换运行环境，快速修改前置URL等参数，CodeArts API提供了环境管理功能。
Committer 开发人员 测试人员 参与者 浏览者 注册APIG 创建 注册API Y Y N N Y N N N N N N 查看 查看注册API Y Y Y Y Y Y Y Y Y Y Y 编辑 重新注册API Y Y N N Y N N N N N N 删除 删除注册API Y Y
Committer 开发人员 测试人员 参与者 浏览者 注册APIG 创建 注册API Y Y N N Y N N N N N N 查看 查看注册API Y Y Y Y Y Y Y Y Y Y Y 编辑 重新注册API Y Y N N Y N N N N N N 删除 删除注册API Y Y
浏览器访问 访问CodeArts API产品官网首页，单击“网页版体验”，填写华为云账户密码进行登录，进入CodeArts API首页。 首次登录CodeArts API服务，系统将为用户默认创建示例项目，并进入项目，用户可基于项目中的示例接口认识API相关概念并熟悉产品使用方法。 浏览器扩展
推送接口 CodeArts API支持将设计完成的接口推送至第三方URL。 单击“项目设置 > 导出数据”，默认进入“第三方推送”页签。 单击“新建”，弹出“新增同步任务”窗口。 配置任务参数，参数配置请参考下表。 参数 配置说明 任务名称 同步任务名称，只允许输入字母、汉字、数
浏览器访问 访问CodeArts API产品官网首页，单击“网页版体验”，填写华为云账户密码进行登录，进入CodeArts API首页。 首次登录CodeArts API服务，系统将为用户默认创建示例项目，并进入项目，用户可基于项目中的示例接口认识API相关概念并熟悉产品使用方法。 浏览器扩展
识别出来的接口和数据模型导入。 一个文件导入后，将会视为一个根目录，一个根目录中不允许存在URL相同的接口。 Postman支持Collections和Environment数据集ZIP包的全量导入，也支持单个Collection文件导入。 Postman支持接口和接口用例的前置脚本及后置脚本导入。
导出接口 在接口目录或已设计好的接口功能目录中，可以导出OpenAPI 3.0、Swagger 2.0版本格式的接口文件，且文件格式支持Yaml、Json。 单击接口目录或接口功能目录名称右侧，选择“导出”。 在弹出的“导出”窗口中，选择需要导出的数据格式及接口，单击“导出”。 父主题：
导入接口 功能说明 CodeArts API支持导入以下API数据格式文件，方便数据迁移。 Swagger Postman（支持Collections和Environment数据集ZIP包） Jmeter Swagger URL 约束与限制 导入文件时，一个文件导入后，将会视为一
导出接口 在接口目录或已设计好的接口功能目录中，可以导出OpenAPI 3.0、Swagger 2.0版本格式的接口文件，且文件格式支持Yaml、Json、Html。 单击接口目录或接口功能目录名称右侧，选择“导出”。 在弹出的“导出”窗口中，选择需要导出的数据格式及接口，单击“导出”。
定时导入接口 CodeArts API支持执行定时任务来导入API接口。 单击“项目设置 > 导入数据”，默认进入“定时导入”页签。 单击“新建”，弹出“新增定时任务”窗口。 配置任务参数，参数配置请参考下表。 参数 配置说明 任务名称 定时任务名称，只允许输入字母、汉字、数字、下划线、中划线，长度3-64个字符。
兼容Postman脚本语法，可以在CodeArts API中直接运行Postman脚本。 Postman中Run collection功能可以通过使用CodeArts API的API测试实现，支持接口的自动化测试，可视化界面灵活编排测试用例顺序，无需修改脚本，实现“零代码”快速生成测试用例，具体API测试操作可参照API测试导读。
定时导入接口 CodeArts API支持执行定时任务来导入API接口。 单击“项目设置 > 导入数据”，默认进入“定时导入”页签。 单击“新建”，弹出“新增定时任务”窗口。 配置任务参数，参数配置请参考下表。 参数 配置说明 任务名称 定时任务名称，只允许输入字母、汉字、数字、下划线、中划线，长度3-64个字符。
创建、管理项目 创建项目 拥有创建项目权限的用户可以在CodeArts API的控制台创建新的项目。 登录CodeArts API控制台，单击“创建项目”，弹出“创建项目”窗口。 填写项目基本信息。 表1 新建项目参数说明 字段名称 是否必填 备注说明 项目名称 是 项目名称，限制128个字符。
创建、管理项目 创建项目 拥有创建项目权限的用户可以在CodeArts API的控制台创建新的项目。 登录CodeArts API控制台，单击“创建项目”，弹出“创建项目”窗口。 填写项目基本信息。 表1 新建项目参数说明 字段名称 是否必填 备注说明 项目名称 是 项目名称，限制128个字符。
导入/导出接口 导入接口 定时导入接口 导出接口 父主题： 导入与导出
客户端1.0.0版本正式发布，提供API表单化设计、文档管理、Mock&本地调试、快捷调试、规范校验、自动化测试及项目团队管理能力。 2023-05-22 - 2.0.0 Windows X86 新特性： 增加公共组件编辑功能，不可视字符进行高亮提示，API测试增加默认变量MockURL。
导入/导出接口 导入接口 定时导入接口 导出接口 推送接口 父主题： 导入与导出
公共参数文档页面可以查看引用当前公共参数的API。 公共请求体 接口的公共请求体，默认请求类型为“application/json”。 支持设计Body体引用，并且在公共请求体的文档页面支持查看引用当前公共请求体的API。 公共示例 接口的公共示例，可在API设计请求体示例与返回响应的响应示
项目概况 进入CodeArts API目标项目后，默认进入项目概况页面，可查看项目下数据统计及API集合情况。 父主题： API设计
长按/截图保存，微信识别二维码
或者关注公众号“华为云”
