检测到您已登录华为云国际站账号,为了您更好的体验,建议您访问国际站服务网站 https://www.huaweicloud.com/intl/zh-cn
不再显示此消息
CodeArts目前推出了体验版套餐,将原来仅支持5人免费使用的套餐,升级为支持50人团队免费使用的升级版套餐。 需要升级套餐的用户,需先退订再购买,退订不影响原有资源。但是需要注意,新版免费套餐限制试用API测试能力,可以通过免费开启高阶功能试用,体验API测试的高阶能力,
认证类—GetIAMToken 认证类—OAuth2ForOneAccess 数据库操作类 数据库类—MySQLQuery 数据库类—MySQLUpdate 数据库类—MySQLInsert 数据库类—MySQLDelete 数据库类—OpenGaussQuery 数据库类—OpenGaussUpdate
CodeArts API Web版本需要安装浏览器扩展,通过浏览器扩展发送请求。 有调用数据库/本地代码、发送Cookie、部分header等限制;请在客户端中使用上述功能。 单击项目名称,进入目标项目后,单击“自动选择 >下载”。 下载后解压文件到文件夹中。 在Chrome浏览器设置页面单击左下角“扩展程序”。
认证类—GetIAMToken 认证类—OAuth2ForOneAccess 数据库操作类 数据库类—MySQLQuery 数据库类—MySQLUpdate 数据库类—MySQLInsert 数据库类—MySQLDelete 数据库类—OpenGaussQuery 数据库类—OpenGaussUpdate
API控制台,单击“创建项目”,弹出“创建项目”窗口。 填写项目基本信息。 表1 新建项目参数说明 字段名称 是否必填 备注说明 项目名称 是 项目名称,限制128个字符。 项目描述 否 项目描述,限制1024个字符。 单击“确定”,完成项目创建。 CodeArts API还支持查看和使用在软件开发生产线CodeArts中创建的IPD项目。
API控制台,单击“创建项目”,弹出“创建项目”窗口。 填写项目基本信息。 表1 新建项目参数说明 字段名称 是否必填 备注说明 项目名称 是 项目名称,限制128个字符。 项目描述 否 项目描述,限制1024个字符。 单击“确定”,完成项目创建。 CodeArts API还支持查看和使用在软件开发生产线CodeArts中创建的IPD项目。
查看接口变更对比 当进行新增、修改、删除API接口的操作后,接口列表会出现相应提示图标。 单击变更的API接口,在API“文档”页面单击“变更对比”。 弹出“变更对比”页面,可查看API接口变更前后的对比详情。 其他项目参与者有权限同步查看项目下任意API接口的变更详情。 提交审核
后才可生效。 约束与限制 审核流程结束前,提交审核的API接口将处于锁定状态,不可编辑和删除。 查看接口变更对比 当进行新增、修改、删除API接口的操作后,接口列表会出现相应提示图标。 单击变更的API接口,在API“文档”页面单击“变更对比”。 弹出“变更对比”页面,可查看API接口变更前后的对比详情。
单击左侧“加载已解压的扩展程序”。 加载2已解压的文件夹。 单击加载后,即可在Chrome浏览器扩展程序中管理已加载的浏览器扩展。 约束与限制 有调用数据库/本地代码、发送Cookie、部分header等限制;请在客户端中使用上述功能。 父主题: 访问CodeArts API服务
API的客户端与Web端差异 CodeArts API的客户端与Web端在主要功能使用上没有明显差异,但在少部分特定场景下,Web端因受限于浏览器的限制,无法支持如设置全局代理、使用快捷键等功能。推荐使用客户端,享受更全面的功能体验。 父主题: 功能相关
Mock”,“API发布”等特性免费开放给所有开发者,用户仅需要开通“CodeArts体验版”套餐,即可免费使用CodeArts API服务,限制人数50人。 “API测试”的“测试用例”与“测试套件”,集成了CodeArts TestPlan的“接口自动化测试”与“测试执行”两个特
操作步骤 单击,弹出“接口审核”页面,默认可查看项目中所有“待审核”状态的API接口列表。 单击操作列的,弹出“审核详情”页面,可查看API接口变更前后的对比详情。 填写“审核意见”,单击“通过”或“拒绝”,完成API接口的审核。 对于已提交审核的API接口,提交人员可通过进入“接口审核”页面进行撤回审核的操作。
访问客户端 客户端支持登录和未登录使用。 约束与限制 导入与导出功能需要登录后才可以继续使用。 前置脚本、后置脚本功能需要登录后才可继续使用。 登录使用 单击“登录/注册”,填写华为云账户密码进行登录。 首次登录CodeArts API服务,系统将为用户默认创建示例项目,并进入项
操作步骤 单击,弹出“接口审核”页面,默认可查看项目中所有“待审核”状态的API接口列表。 单击操作列的,弹出“审核详情”页面,可查看API接口变更前后的对比详情。 填写“审核意见”,单击“通过”或“拒绝”,完成API接口的审核。 对于已提交审核的API接口,提交人员可通过进入“接口审核”页面进行撤回审核的操作。
版本管理 CodeArts API提供API设计版本管理功能,可在不同版本之间进行快速切换,也可对不同版本API接口进行直接对比。 约束与限制 克隆成项目时,只支持API设计模块中的API接口设计克隆为新项目中API设计模块的接口设计,API测试模块暂不支持克隆当前API测试模块相关测试用例与测试套件。
Markdown设计 约束与限制 Markdown文件只能在同一根目录下进行移动。 处于编辑页面的Markdown文件不能移动。 创建Markdown文件 新建Markdown,可通过以下三种方式完成。 方法一:单击目录树搜索框右侧的,在弹出的下拉框中,选择“新建Markdown”。
完成API设计之后,在API文档页面单击“运行”会自动切换到API调试页面,也可以单击“调试”页签切换到API调试页面,本节介绍调试页面相关信息配置。 由于浏览器限制,使用CodeArts API的Web版本进行接口调试,需要先安装浏览器扩展,浏览器扩展请查看浏览器扩展。 接口路径 API调试页面的接口
API提供同项目内两个不同版本的API对比功能。 在“版本管理”页面,选择需要对比的两个版本,单击“版本API接口对比”,可对比不同版本的具体内容和变更细节。 接口导出 CodeArts API提供不同版本接口的导出功能。 在“版本管理”页面,单击目标版本所在行的,选择“导出”。 选择文件
完成API设计之后,在API文档页面单击“运行”会自动切换到API调试页面,也可以单击“调试”页签切换到API调试页面,本节介绍调试页面相关信息配置。 约束与限制 由于浏览器限制,使用CodeArts API的Web版本进行接口调试,需要先安装浏览器扩展,浏览器扩展请查看浏览器扩展。 接口路径 API调试页
Swagger Postman(支持Collections和Environment数据集ZIP包) Jmeter Swagger URL 约束与限制 导入文件时,一个文件导入后,将会视为一个根目录,一个根目录中不允许存在URL相同的接口。 手动导入 通过主页面的“更多功能”选项或单击左