检测到您已登录华为云国际站账号，为了您更好的体验，建议您访问国际站服务网站 https://www.huaweicloud.com/intl/zh-cn
不再显示此消息
检测到您已登录华为云国际站账号，为了您更好的体验，建议您访问国际站服务网站 https://www.huaweicloud.com/intl/zh-cn
不再显示此消息
API规范设计定义，请参照设置API设计规范。 编辑模式 规范性检查 设置API设计规范 单击项目名称，进入目标项目，单击“项目设置 > 设计规范设置”，进入“设计规范设置”页面。 新增设计规范 在“设计规范”页签，单击“新增设计规范”，填写规范名称，选择是否继承已创建的规范、填写规范描述。
API规范设计定义，请参照设置API设计规范。 编辑模式 规范性检查 设置API设计规范 单击项目名称，进入目标项目，单击“项目设置 > 设计规范设置”，进入“设计规范设置”页面。 新增设计规范 在“设计规范”页签，单击“新增设计规范”，填写规范名称，选择是否继承已创建的规范、填写规范描述。
串。 字段 说明 出参名称 用于之后使用${出参名称}来引用此参数，名称使用字母数字下划线。 来源 被检测字段的来源，如响应体（JSON）、响应头、响应码。 属性 若来源是响应码，属性为空。详细介绍请参见响应码检查。 若来源是响应头，属性为响应头中字段的名称。详细介绍请参见响应头检查。
串。 字段 说明 出参名称 用于之后使用${出参名称}来引用此参数，名称使用字母数字下划线。 来源 被检测字段的来源，如响应体（JSON）、响应头、响应码。 属性 若来源是响应码，属性为空。详细介绍请参见响应码检查。 若来源是响应头，属性为响应头中字段的名称。详细介绍请参见响应头检查。
API的客户端与Web端差异 CodeArts API的客户端与Web端在主要功能使用上没有明显差异，但在少部分特定场景下，Web端因受限于浏览器的限制，无法支持如设置全局代理、使用快捷键等功能。推荐使用客户端，享受更全面的功能体验。 父主题： 功能相关
API 操作指导 CodeArts API 介绍如何创建API设计及两种设计编辑模式 03:20 创建API设计 CodeArts API 介绍如何设置API设计规范 01:33 API规范性检查 CodeArts API 教你如何利用Mock功能及调试API 02:47 使用API
前提条件 拥有“通用设置”->“项目”的编辑权限。 拥有“通用设置”->“角色”->“成员设置”权限，可以添加成员或将成员移出项目。 拥有“通用设置”->“角色”->“权限设置”权限，可以给成员分配角色。 项目创建者拥有所有的权限。 成员设置入口 单击项目名称，进入目标项目，单击“项目设置
前提条件 拥有“通用设置”->“项目”的编辑权限。 拥有“通用设置”->“角色”->“成员设置”权限，可以添加成员或将成员移出项目。 拥有“通用设置”->“角色”->“权限设置”权限，可以给成员分配角色。 项目创建者拥有所有的权限。 成员设置入口 单击项目名称，进入目标项目，单击“项目设置
如何从Postman无缝迁移到CodeArts API？ 可以在API设计页面，通过单击搜索栏旁边，选择“导入Postman文件”来导入Postman存量数据，具体导入操作可参照导入接口，支持导入的数据格式为： Collections和Environment数据集ZIP包 单个Collection文件
表1 通用设置默认角色权限说明 服务资源 权限 权限说明 项目管理员 项目经理 产品经理 测试经理 运维经理 系统工程师 Committer 开发人员 测试人员 参与者 浏览者 角色 权限设置 设置角色权限 Y Y N Y N N N N N N N 成员设置 设置项目成员 Y
表1 通用设置默认角色权限说明 服务资源 权限 权限说明 项目管理员 项目经理 产品经理 测试经理 运维经理 系统工程师 Committer 开发人员 测试人员 参与者 浏览者 角色 权限设置 设置角色权限 Y Y N Y N N N N N N N 成员设置 设置项目成员 Y
审核设置 API设计审核为用户提供了一套成熟的审核流程，帮助检查项目中设计的API接口是否符合需求。 角色权限 项目经理和项目创建者有审核设置权限。 开启审核功能 单击“项目设置 > 功能设置”，进入“功能设置”页面。 在“审核设置”页签，审核设置按钮默认为关闭状态，单击，开启审核功能。
审核设置 API设计审核为用户提供了一套成熟的审核流程，帮助检查项目中设计的API接口是否符合需求。 角色权限 项目经理和项目创建者有审核设置权限。 开启审核功能 单击“项目设置 > 功能设置”，进入“功能设置”页面。 在“审核设置”页签，审核设置按钮默认为关闭状态，单击，开启审核功能。
登录CodeArts API控制台，单击“创建项目”，弹出“创建项目”窗口。 填写项目基本信息。 表1 新建项目参数说明 字段名称 是否必填 备注说明 项目名称 是 项目名称，限制128个字符。 项目描述 否 项目描述，限制1024个字符。 单击“确定”，完成项目创建。 CodeArts
登录CodeArts API控制台，单击“创建项目”，弹出“创建项目”窗口。 填写项目基本信息。 表1 新建项目参数说明 字段名称 是否必填 备注说明 项目名称 是 项目名称，限制128个字符。 项目描述 否 项目描述，限制1024个字符。 单击“确定”，完成项目创建。 CodeArts
Fox项目及YApi项目中的API设计导入CodeArts API中。 API Fox项目导入 导出数据 打开API Fox对应项目，单击“项目设置 > 导出数据”，进入“导出数据”页面。 选择“Apifox”数据格式，单击”导出”，完成导出。 导入数据 打开CodeArts API首页，单击“导入项目”。
Fox项目及YApi项目中的API设计导入CodeArts API中。 API Fox项目导入 导出数据 打开API Fox对应项目，单击“项目设置 > 导出数据”，进入“导出数据”页面。 选择“Apifox”数据格式，单击”导出”，完成导出。 导入数据 打开CodeArts API首页，单击“导入项目”。
GET、POST、PUT、DELETE 等请求。 单击“URL请求”选项，添加“自定义URL请求”测试步骤。 在自定义请求中可编辑请求名称、地址和请求参数等信息，详细参照设置接口请求章节。 从postman文件导入 接口自动化测试用例支持通过导入Postman文件，生成测试步骤。 导入Postman文件需满足以下要求：
GET、POST、PUT、DELETE 等请求。 单击“URL请求”选项，添加“自定义URL请求”测试步骤。 在自定义请求中可编辑请求名称、地址和请求参数等信息，详细参照设置接口请求章节。 从postman文件导入 接口自动化测试用例支持通过导入Postman文件，生成测试步骤。 导入Postman文件需满足以下要求：
测试检查点 在测试步骤请求中可以设置请求结果的检查点，方便用户检测当前接口的返回值，验证测试步骤是否得到预期结果。 设置建议 推荐用户设置检查点。针对接口类请求，请提供判断响应码的检查点。 当检查点设置为空，不论接口的响应码是什么，都会判断结果为成功。 检查点说明 测试检查点即请
长按/截图保存，微信识别二维码
或者关注公众号“华为云”
