检测到您已登录华为云国际站账号,为了您更好的体验,建议您访问国际站服务网站 https://www.huaweicloud.com/intl/zh-cn
不再显示此消息
在“审核设置”页签,审核设置按钮默认为关闭状态,单击,开启审核功能。 开启审核功能后,在项目下API设计中创建、删除、修改API的操作均会被记录为草稿内容,需要通过审核后生效。 关闭审核功能 在“审核设置”页签,单击,弹出“审核设置”对话框。 根据提示输入“CLOSE”后,单击“确定”,关闭审核功能。 关
如何从Postman无缝迁移到CodeArts API? 可以在API设计页面,通过单击搜索栏旁边,选择“导入Postman文件”来导入Postman存量数据,具体导入操作可参照导入接口,支持导入的数据格式为: Collections和Environment数据集ZIP包 单个Collection文件
在“审核设置”页签,审核设置按钮默认为关闭状态,单击,开启审核功能。 开启审核功能后,在项目下API设计中创建、删除、修改API的操作均会被记录为草稿内容,需要通过审核后生效。 关闭审核功能 在“审核设置”页签,单击,弹出“审核设置”对话框。 根据提示输入“CLOSE”后,单击“确定”,关闭审核功能。 关
使用的套餐,升级为支持50人团队免费使用的升级版套餐。 需要升级套餐的用户,需先退订再购买,退订不影响原有资源。但是需要注意,新版免费套餐限制试用API测试能力,可以通过免费开启高阶功能试用,体验API测试的高阶能力,具体套餐详情请参照CodeArts套餐概述。 操作步骤 打开云
API控制台,单击“创建项目”,弹出“创建项目”窗口。 填写项目基本信息。 表1 新建项目参数说明 字段名称 是否必填 备注说明 项目名称 是 项目名称,限制128个字符。 项目描述 否 项目描述,限制1024个字符。 单击“确定”,完成项目创建。 CodeArts API还支持查看和使用在软件开发生产线CodeArts中创建的IPD项目。
API控制台,单击“创建项目”,弹出“创建项目”窗口。 填写项目基本信息。 表1 新建项目参数说明 字段名称 是否必填 备注说明 项目名称 是 项目名称,限制128个字符。 项目描述 否 项目描述,限制1024个字符。 单击“确定”,完成项目创建。 CodeArts API还支持查看和使用在软件开发生产线CodeArts中创建的IPD项目。
单击左侧“加载已解压的扩展程序”。 加载2已解压的文件夹。 单击加载后,即可在Chrome浏览器扩展程序中管理已加载的浏览器扩展。 约束与限制 有调用数据库/本地代码、发送Cookie、部分header等限制;请在客户端中使用上述功能。 父主题: 访问CodeArts API服务
API的客户端与Web端差异 CodeArts API的客户端与Web端在主要功能使用上没有明显差异,但在少部分特定场景下,Web端因受限于浏览器的限制,无法支持如设置全局代理、使用快捷键等功能。推荐使用客户端,享受更全面的功能体验。 父主题: 功能相关
调试页面,本节介绍调试页面相关信息配置。 由于浏览器限制,使用CodeArts API的Web版本进行接口调试,需要先安装浏览器扩展,浏览器扩展请查看浏览器扩展。 接口路径 API调试页面的接口路径,可以选择http或https,并在定义的路径前自动添加了域名。添加的域名是在右上
访问客户端 客户端支持登录和未登录使用。 约束与限制 导入与导出功能需要登录后才可以继续使用。 前置脚本、后置脚本功能需要登录后才可继续使用。 登录使用 单击“登录/注册”,填写华为云账户密码进行登录。 首次登录CodeArts API服务,系统将为用户默认创建示例项目,并进入项
Mock”,“API发布”等特性免费开放给所有开发者,用户仅需要开通“CodeArts体验版”套餐,即可免费使用CodeArts API服务,限制人数50人。 “API测试”的“测试用例”与“测试套件”,集成了CodeArts TestPlan的“接口自动化测试”与“测试执行”两个特
CodeArts API Web版本需要安装浏览器扩展,通过浏览器扩展发送请求。 有调用数据库/本地代码、发送Cookie、部分header等限制;请在客户端中使用上述功能。 单击项目名称,进入目标项目后,单击“自动选择 >下载”。 下载后解压文件到文件夹中。 在Chrome浏览器设置页面单击左下角“扩展程序”。
提交审核 审核功能开启后,对于API接口的操作都需要提交审核并通过后才可生效。 约束与限制 审核流程结束前,提交审核的API接口将处于锁定状态,不可编辑和删除。 查看接口变更对比 当进行新增、修改、删除API接口的操作后,接口列表会出现相应提示图标。 单击变更的API接口,在API“文档”页面单击“变更对比”。
API 操作指导 CodeArts API 介绍如何创建API设计及两种设计编辑模式 03:20 创建API设计 CodeArts API 介绍如何设置API设计规范 01:33 API规范性检查 CodeArts API 教你如何利用Mock功能及调试API 02:47 使用API
完成API设计之后,在API文档页面单击“运行”会自动切换到API调试页面,也可以单击“调试”页签切换到API调试页面,本节介绍调试页面相关信息配置。 约束与限制 由于浏览器限制,使用CodeArts API的Web版本进行接口调试,需要先安装浏览器扩展,浏览器扩展请查看浏览器扩展。 接口路径 API调试页
选择需要导入的根目录。支持手动输入新的目录名称或为空,为空时将默认以任务名称命名。 单击“确定”,完成定时导入任务创建。 在“定时导入”页面单击“是否启用”,设置启用/关闭定时任务。启用定时任务后开始计时,根据设置的时间间隔完成导入任务。 (可选)可复制定时导入任务。单击操作的,选择“复制”,配置任务参数,完成定时导入任务的复制。
在前序测试步骤定义,后续测试步骤使用。 在前序测试步骤中,在“响应提取”页签创建要传递的参数。响应提取来源用到内置参数,请参考内置参数了解如何使用内置参数。响应提取同时支持正则表达式的匹配,提取出与给定正则表达式匹配的返回值。 在后续测试步骤中,通过“${参数名}”方式引用前序测
选择需要导入的根目录。支持手动输入新的目录名称或为空,为空时将默认以任务名称命名。 单击“确定”,完成定时导入任务创建。 在“定时导入”页面单击“是否启用”,设置启用/关闭定时任务。启用定时任务后开始计时,根据设置的时间间隔完成导入任务。 (可选)可复制定时导入任务。单击操作的,选择“复制”,配置任务参数,完成定时导入任务的复制。
在前序测试步骤定义,后续测试步骤使用。 在前序测试步骤中,在“响应提取”页签创建要传递的参数。响应提取来源用到内置参数,请参考内置参数了解如何使用内置参数。响应提取同时支持正则表达式的匹配,提取出与给定正则表达式匹配的返回值。 在后续测试步骤中,通过“${参数名}”方式引用前序测
API中心发布 介绍如何将已开发好的API分享至API中心。 前提条件 已完成服务商入驻。 操作步骤 单击项目名称,进入目标项目详情页面,单击“API发布 > API中心发布”。 单击“申请发布”,跳转至“创建API资产”页面。 选择导入API、填写API资产信息,参数说明请分别参见表1、表2。