检测到您已登录华为云国际站账号,为了您更好的体验,建议您访问国际站服务网站 https://www.huaweicloud.com/intl/zh-cn
不再显示此消息
N N N N N N N N N 查看 查看版本管理页面权限 Y Y Y Y Y Y Y Y Y Y Y 编辑 版本管理页面编辑按钮权限 Y Y N N N N N N N N N 删除 版本管理页面删除按钮权限 Y Y N N N N N N N N N 定时导入API 创建
N N N N N N N N N 查看 查看版本管理页面权限 Y Y Y Y Y Y Y Y Y Y Y 编辑 版本管理页面编辑按钮权限 Y Y N N N N N N N N N 删除 版本管理页面删除按钮权限 Y Y N N N N N N N N N 定时导入API 创建
Query参数:在Params页签查看,默认填充了接口定义好了的Query参数,名称可修改。 Path参数:在Params页签查看,默认填充了接口定义好了的Path参数,名称不可修改。 Header参数:默认填充了接口定义好了的Query参数,名称可修改。 请求体 在Body页签中,可以查看请求体,目前支持的请求体有如下几类:
Query参数:在Params页签查看,默认填充了接口定义好了的Query参数,名称可修改。 Path参数:在Params页签查看,默认填充了接口定义好了的Path参数,名称不可修改。 Header参数:默认填充了接口定义好了的Query参数,名称可修改。 请求体 在Body页签中,可以查看请求体,目前支持的请求体有如下几类:
不可编辑和删除。 查看接口变更对比 当进行新增、修改、删除API接口的操作后,接口列表会出现相应提示图标。 单击变更的API接口,在API“文档”页面单击“变更对比”。 弹出“变更对比”页面,可查看API接口变更前后的对比详情。 其他项目参与者有权限同步查看项目下任意API接口的变更详情。
创建、管理项目 创建项目 拥有创建项目权限的用户可以在CodeArts API的控制台创建新的项目。 登录CodeArts API控制台,单击“创建项目”,弹出“创建项目”窗口。 填写项目基本信息。 表1 新建项目参数说明 字段名称 是否必填 备注说明 项目名称 是 项目名称,限制128个字符。
创建、管理项目 创建项目 拥有创建项目权限的用户可以在CodeArts API的控制台创建新的项目。 登录CodeArts API控制台,单击“创建项目”,弹出“创建项目”窗口。 填写项目基本信息。 表1 新建项目参数说明 字段名称 是否必填 备注说明 项目名称 是 项目名称,限制128个字符。
版本管理 CodeArts API提供API设计版本管理功能,可在不同版本之间进行快速切换,也可对不同版本API接口进行直接对比。 创建版本 单击项目名称,进入目标项目,单击“项目设置 > 版本管理”,进入“版本管理”页面。 单击“新增版本”,填写版本号和描述,默认勾选“同步创建测试版本”。
API提供不同版本接口的导出功能。 在“版本管理”页面,单击目标版本所在行的,选择“导出”。 选择文件在本地存储位置、设置文件名,保存到本地,解压后可查看导出的接口文件。 测试用例导入 CodeArts API提供不同版本测试用例的导入功能。 在“版本管理”页面,单击目标版本操作列的,选择“导入”。
套餐相关 当前套餐人数不够用怎么办?
功能相关 快捷调试的接口代码怎么获取? CodeArts API是否支持离线使用? 如何从Postman无缝迁移到CodeArts API? CodeArt API的客户端与Web端差异
“导入”。 弹出导入进度对话框,可查看导入进度。 导入完成后,可进入导入项目,查看导入的接口和数据模型。 目前导入接口的前置操作和后置操作仅支持自定义脚本导入。 YApi项目导入 导出数据 打开YApi对应项目,单击“数据管理”,进入“数据管理”页面。 在导出数据模块中,选择“json”数据方式,单击导出,完成导出。
O_PROXY,勾选后,CodeArts API会优先调用系统环境变量。 身份认证:请查看身份认证。 不使用代理 选择不使用代理时,此时CodeArts API不使用任何代理(包含系统代理)连接服务器。 自定义 选择自定义代理时,需配置“接口类型”、“代理服务器”、“身份认证”、“Proxy
“导入”。 弹出导入进度对话框,可查看导入进度。 导入完成后,可进入导入项目,查看导入的接口和数据模型。 目前导入接口的前置操作和后置操作仅支持自定义脚本导入。 YApi项目导入 导出数据 打开YApi对应项目,单击“数据管理”,进入“数据管理”页面。 在导出数据模块中,选择“json”数据方式,单击导出,完成导出。
O_PROXY,勾选后,CodeArts API会优先调用系统环境变量。 身份认证:请查看身份认证。 不使用代理 选择不使用代理时,此时CodeArts API不使用任何代理(包含系统代理)连接服务器。 自定义 选择自定义代理时,需配置“接口类型”、“代理服务器”、“身份认证”、“Proxy
接口,即“API设计”的接口数据。 单击“导入”,完成测试步骤添加。 自定义请求 在测试用例中,可能需要调用项目之外的接口,例如在请求华为终端app前,需要调用账号服务的获取用户认证token。此时用户可以在测试步骤中添加自定义请求,自定义请求可以是任何 HTTP 请求,包括常见的
接口,即“API设计”的接口数据。 单击“导入”,完成测试步骤添加。 自定义请求 在测试用例中,可能需要调用项目之外的接口,例如在请求华为终端app前,需要调用账号服务的获取用户认证token。此时用户可以在测试步骤中添加自定义请求,自定义请求可以是任何 HTTP 请求,包括常见的
数据结构被引用后,可以在数据结构的文档页面查看引用当前数据结构的API和模型。 公共响应 接口的公共响应返回结果,响应类型默认为“application/json”结构。 在设计API的响应体时,可以直接引用已设计好的公共响应。 公共响应文档页面可以查看引用当前公共响应的API。 公共参数
数据结构被引用后,可以在数据结构的文档页面查看引用当前数据结构的API和模型。 公共响应 接口的公共响应返回结果,响应类型默认为“application/json”结构。 在设计API的响应体时,可以直接引用已设计好的公共响应。 公共响应文档页面可以查看引用当前公共响应的API。 公共参数
确认云端MockURL,详细Mock规则查询请参照高级Mock。 单击“发送”。 在响应体中查看响应。 高级Mock CodeArts API提供高级Mock功能,可以查询和定义调试接口的Mock规则。 单击接口的“高级Mock”页签,可以查看该接口对应的Mock规则。 单击“查询产品列表”,弹出“编辑Mock规则”页面。