检测到您已登录华为云国际站账号,为了您更好的体验,建议您访问国际站服务网站 https://www.huaweicloud.com/intl/zh-cn
不再显示此消息
使用CodeArts API快速设计并调试接口 访问CodeArts API产品首页,单击“网页版体验”,首次使用华为云账号登录CodeArts API的用户,系统将默认为该用户新建“示例项目”并进入项目,用户可基于示例接口认识API相关概念并熟悉产品使用方法。 使用API设计
deArts中创建的IPD项目。 修改项目基本信息 单击项目名称,进入目标项目,单击“项目设置 > 基本信息”,可以修改项目基本信息。 在“基本信息”模块,可以根据实际需要修改项目名称、项目描述等。 修改完成后,单击“保存”。 创建时间不支持修改。 删除项目 在“删除项目”模块,
要根据设计文档实现代码,如果设计修改则需要手工实现代码同步。 后端工程师在API调试时,需要将设计文件导入Postman,如果设计修改则需要重复导入过程。 前端工程师需要根据设计文档在Mockjs中定义Mock返回数据,如果设计修改则需要手工修改Mock数据。 测试工程师根据设计
有“已测完”或“已发布”状态的API。 选中需要发布的API,单击“下一步”。 在“选择运行时实例”的下拉框中选择需要注册的APIG实例,并配置实例参数。参数配置请参考APIG实例参数表。 APIG实例参数 参数 配置说明 API分组 在APIG实例上已创建的API集合,创建操作可参照创建API分组章节。
API还支持查看和使用在软件开发生产线CodeArts中创建的IPD项目。 修改项目基本信息 单击项目名称,进入目标项目,单击“项目设置 > 基本信息”,可以修改项目基本信息。 在“基本信息”模块,可以根据实际需要修改项目名称、项目描述等。 修改完成后,单击“保存”。 删除项目 在“删除项目”模块,单
要根据设计文档实现代码,如果设计修改则需要手工实现代码同步。 后端工程师在API调试时,需要将设计文件导入Postman,如果设计修改则需要重复导入过程。 前端工程师需要根据设计文档在Mockjs中定义Mock返回数据,如果设计修改则需要手工修改Mock数据。 测试工程师根据设计
有“已测完”或“已发布”状态的API。 选中需要发布的API,单击“下一步”。 在“选择运行时实例”的下拉框中选择需要注册的APIG实例,并配置实例参数。参数配置请参考APIG实例参数表。 APIG实例参数 参数 配置说明 API分组 在APIG实例上已创建的API集合,创建操作可参照创建API分组章节。
浏览者 用例 创建 创建用例 Y Y Y Y N Y Y Y Y N N 查看 查看用例 Y Y Y Y Y Y Y Y Y Y Y 修改 修改用例 Y Y Y Y N Y Y Y Y N N 删除 删除用例 Y Y Y Y N Y Y Y Y N N 执行 执行用例 Y Y Y
Query参数:在Params页签查看,默认填充了接口定义好了的Query参数,名称可修改。 Path参数:在Params页签查看,默认填充了接口定义好了的Path参数,名称不可修改。 Header参数:默认填充了接口定义好了的Query参数,名称可修改。 请求体 在Body页签中,可以查看请求体,目前支持的请求体有如下几类:
浏览者 用例 创建 创建用例 Y Y Y Y N Y Y Y Y N N 查看 查看用例 Y Y Y Y Y Y Y Y Y Y Y 修改 修改用例 Y Y Y Y N Y Y Y Y N N 删除 删除用例 Y Y Y Y N Y Y Y Y N N 执行 执行用例 Y Y Y
Query参数:在Params页签查看,默认填充了接口定义好了的Query参数,名称可修改。 Path参数:在Params页签查看,默认填充了接口定义好了的Path参数,名称不可修改。 Header参数:默认填充了接口定义好了的Query参数,名称可修改。 请求体 在Body页签中,可以查看请求体,目前支持的请求体有如下几类:
了解服务器所支持的方法和功能。 HEAD(请求头):与GET类似,但只返回响应头部,不返回实体内容,用于获取资源的元信息,如:文件大小、修改日期等。 PATCH(补丁):用于对资源进行局部更新。PATCH请求类似于PUT请求,但是只更新资源的一部分。 TRACE(跟踪):用于建
选择无需检查接口,单击“确定”,完成添加。 快捷搜索 可输入关键字快捷查找已存在的设计规范。 设计规范定义更新 单击“管理”,可以修改设计规范中启用的设计规则。 单击“编辑”,可以修改设计规范的名称和描述。 设计规范删除 单击“删除”,可以删除设计规范。 父主题: API设计
了解服务器所支持的方法和功能。 HEAD(请求头):与GET类似,但只返回响应头部,不返回实体内容,用于获取资源的元信息,如:文件大小、修改日期等。 PATCH(补丁):用于对资源进行局部更新。PATCH请求类似于PUT请求,但是只更新资源的一部分。 TRACE(跟踪):用于建
选择无需检查接口,单击“确定”,完成添加。 快捷搜索 可输入关键字快捷查找已存在的设计规范。 设计规范定义更新 单击“管理”,可以修改设计规范中启用的设计规则。 单击“编辑”,可以修改设计规范的名称和描述。 设计规范删除 单击“删除”,可以删除设计规范。 父主题: API设计
Postman中Run collection功能可以通过使用CodeArts API的API测试实现,支持接口的自动化测试,可视化界面灵活编排测试用例顺序,无需修改脚本,实现“零代码”快速生成测试用例,具体API测试操作可参照API测试导读。 父主题: 功能相关
API保证API各阶段数据高度一致,为开发者提供友好易用的API全流程端到端解决方案。借助CodeArts API,开发者可以高效、规范、准确地培育并呵护自己的API,便捷参与API经济。 图1 CodeArts API平台拓扑图
项目管理模块新增定时导入swaggerURL能力;项目管理模块优化权限管理能力,与CodeArts权限同步; 快捷调试模块增加实际请求以及页面内名称修改能力。 2024-07-30 2.0.6 Windows X86 新特性: 项目管理支持YApi文件导入;快捷调试模块中,表单支持复制和另
API保证API各阶段数据高度一致,为开发者提供友好易用的API全流程端到端解决方案。借助CodeArts API,开发者可以高效、规范、准确地培育并呵护自己的API,便捷参与API经济。 图1 CodeArts API平台拓扑图 软件开发生产线 软件开发生产线(CodeArts)是面向开
单击“新增版本”,填写版本号和描述,默认勾选“同步创建测试版本”。 单击“确定”。 单击项目名称下“基线”旁的下拉框,可快速切换版本(支持根据版本名快速搜索),并对版本进行编辑。 因存量版本未在API测试模块中创建,在API测试模块中切换版本时会弹出是否新建版本的提示窗口,请根据需要进行创建。 克隆成项目