检测到您已登录华为云国际站账号,为了您更好的体验,建议您访问国际站服务网站 https://www.huaweicloud.com/intl/zh-cn
不再显示此消息
Mock。 请求参数 Query参数:在Params页签查看,默认填充了接口定义好了的Query参数,名称可修改。 Path参数:在Params页签查看,默认填充了接口定义好了的Path参数,名称不可修改。 Header参数:默认填充了接口定义好了的Query参数,名称可修改。 请求体
Mock。 请求参数 Query参数:在Params页签查看,默认填充了接口定义好了的Query参数,名称可修改。 Path参数:在Params页签查看,默认填充了接口定义好了的Path参数,名称不可修改。 Header参数:默认填充了接口定义好了的Query参数,名称可修改。 请求体
在接口的快捷调试页面单击,选择“保存为接口”。 在“保存为接口”页面输入接口名称,选择接口目录,单击“确定”,保存接口。 单击“API设计”,选择保存的接口,默认进入接口的文档页签。 单击“生成代码”下拉框,获取接口代码,具体操作请参照API开发。 父主题: 功能相关
快速入门 登录CodeArts API 使用华为云账号登录CodeArts API,系统默认为新用户新建“示例项目”并进入项目,用户可基于“示例项目”进行快捷调试。 新建快捷调试 进入项目后,单击搜索框旁,可根据需要选择“新建快捷调试”或“导入Postman文件”进行快捷调试。 新建快捷调试
对比。 创建版本 单击项目名称,进入目标项目,单击“项目设置 > 版本管理”,进入“版本管理”页面。 单击“新增版本”,填写版本号和描述,默认勾选“同步创建测试版本”。 单击“确定”。 单击项目名称下“基线”旁的下拉框,可快速切换版本(支持根据版本名快速搜索),并对版本进行编辑。
对比。 创建版本 单击项目名称,进入目标项目,单击“项目设置 > 版本管理”,进入“版本管理”页面。 单击“新增版本”,填写版本号和描述,默认勾选“同步创建测试版本”。 单击“确定”。 单击项目名称下“基线”旁的下拉框,可快速切换版本(支持根据版本名快速搜索),并对版本进行编辑。
CodeArts API客户端支持离线使用,在登录客户端时,单击“稍后再说”,即可离线使用CodeArts API。但是离线状态下只支持使用默认环境及部分快捷调试功能,无法使用快捷调试中的导入、导出及脚本功能,且离线时快捷调试的接口与登录状态下不同步,具体离线使用操作请参照未登录使用客户端。
查看 所有数据 审核 所有数据 撤回 自己提交的数据 开发人员 查看 所有数据 撤回 自己提交的数据 操作步骤 单击,弹出“接口审核”页面,默认可查看项目中所有“待审核”状态的API接口列表。 单击操作列的,弹出“审核详情”页面,可查看API接口变更前后的对比详情。 填写“审核意见
查看 所有数据 审核 所有数据 撤回 自己提交的数据 开发人员 查看 所有数据 撤回 自己提交的数据 操作步骤 单击,弹出“接口审核”页面,默认可查看项目中所有“待审核”状态的API接口列表。 单击操作列的,弹出“审核详情”页面,可查看API接口变更前后的对比详情。 填写“审核意见
定时导入接口 CodeArts API支持执行定时任务来导入API接口。 单击“项目设置 > 导入数据”,默认进入“定时导入”页签。 单击“新建”,弹出“新增定时任务”窗口。 配置任务参数,参数配置请参考下表。 参数 配置说明 任务名称 定时任务名称,只允许输入字母、汉字、数字、下划线、中划线,长度3-64个字符。
项目经理和项目创建者有审核设置权限。 开启审核功能 单击“项目设置 > 功能设置”,进入“功能设置”页面。 在“审核设置”页签,审核设置按钮默认为关闭状态,单击,开启审核功能。 开启审核功能后,在项目下API设计中创建、删除、修改API的操作均会被记录为草稿内容,需要通过审核后生效。
定时导入接口 CodeArts API支持执行定时任务来导入API接口。 单击“项目设置 > 导入数据”,默认进入“定时导入”页签。 单击“新建”,弹出“新增定时任务”窗口。 配置任务参数,参数配置请参考下表。 参数 配置说明 任务名称 定时任务名称,只允许输入字母、汉字、数字、下划线、中划线,长度3-64个字符。
项目经理和项目创建者有审核设置权限。 开启审核功能 单击“项目设置 > 功能设置”,进入“功能设置”页面。 在“审核设置”页签,审核设置按钮默认为关闭状态,单击,开启审核功能。 开启审核功能后,在项目下API设计中创建、删除、修改API的操作均会被记录为草稿内容,需要通过审核后生效。
公共数据结构。 数据结构被引用后,可以在数据结构的文档页面查看引用当前数据结构的API和模型。 公共响应 接口的公共响应返回结果,响应类型默认为“application/json”结构。 在设计API的响应体时,可以直接引用已设计好的公共响应。 公共响应文档页面可以查看引用当前公共响应的API。
@regexp("[a-z]+\\@gmail\\.com") "ifadt@gmail.com" 支持类型 描述 * 匹配前一个表达式0次或多次,等价于{0,}。 . 默认匹配除换行符之外的任何单个字符(用来生成乱码)。 + 匹配前面一个表达式1次或者多次,等价于{1,}。 ? 匹配前面一个表达式0次或者1次,等价于{0
选择全部要添加的成员,单击“完成”。即可完成项目成员的批量添加。 设置项目成员角色 项目管理员(项目创建者)、项目经理、测试经理默认拥有设置角色权限,可以给成员设置项目角色,项目角色不同,各服务的访问权限也不同。默认的项目角色类型如下: 项目创建者(不可更改) 项目经理 开发人员 测试经理 测试人员 参与者 浏览者
公共数据结构。 数据结构被引用后,可以在数据结构的文档页面查看引用当前数据结构的API和模型。 公共响应 接口的公共响应返回结果,响应类型默认为“application/json”结构。 在设计API的响应体时,可以直接引用已设计好的公共响应。 公共响应文档页面可以查看引用当前公共响应的API。
@regexp("[a-z]+\\@gmail\\.com") "ifadt@gmail.com" 支持类型 描述 * 匹配前一个表达式0次或多次,等价于{0,}。 . 默认匹配除换行符之外的任何单个字符(用来生成乱码)。 + 匹配前面一个表达式1次或者多次,等价于{1,}。 ? 匹配前面一个表达式0次或者1次,等价于{0
选择全部要添加的成员,单击“完成”。即可完成项目成员的批量添加。 设置项目成员角色 项目管理员(项目创建者)、项目经理、测试经理默认拥有设置角色权限,可以给成员设置项目角色,项目角色不同,各服务的访问权限也不同。默认的项目角色类型如下: 项目创建者(不可更改) 项目经理 开发人员 测试经理 测试人员 参与者 浏览者
填写“变更原因”,单击“提交”,提交API接口进入审核流程。 审核流程结束前,该提交审核的API接口将处于锁定状态,不可编辑和删除。 撤回审核 单击,弹出“接口审核”页面,默认可以查看项目中“待审核”状态的API接口列表。 选择需要撤回的API接口,单击操作栏的,进入“审核详情”页面,可查看接口变更前后的对比详情。