检测到您已登录华为云国际站账号,为了您更好的体验,建议您访问国际站服务网站 https://www.huaweicloud.com/intl/zh-cn
不再显示此消息
API管理痛点 传统的API全生命周期管理方案,研发团队通常会使用多种工具管理API: Swagger:设计与管理API文档 Postman:API调试工具 Mockjs:Mock API数据 JMeter:API自动化测试工具 因此,在传统的研发流程中,开发者常常面对以下繁琐的协作场景:
API的客户端与Web端差异 CodeArts API的客户端与Web端在主要功能使用上没有明显差异,但在少部分特定场景下,Web端因受限于浏览器的限制,无法支持如设置全局代理、使用快捷键等功能。推荐使用客户端,享受更全面的功能体验。 父主题: 功能相关
灵活API设计方式 支持表单可视化编辑设计API。 支持Swagger编辑器原生开发者体验。 API设计和API文档 100% 一致,所写即所得,以使用者视角定义API。 API设计规范检查 基于华为10年API治理经验,嵌入国内唯一“先进级”评级的API全生命周期管理规范。 支持API规
灵活API设计方式 支持表单可视化编辑设计API。 支持Swagger编辑器原生开发者体验。 API设计和API文档 100% 一致,所写即所得,以使用者视角定义API。 API设计规范检查 基于华为10年API治理经验,嵌入国内唯一“先进级”评级的API全生命周期管理规范。 支持API规
准备阶段(可选):前置步骤。 在此阶段中准备测试阶段需要的前置条件数据,如果没有前置条件,可以忽略此阶段。 如果前置条件的数据需要在测试阶段中引用,可以使用参数传递将数据参数化后,传递给测试阶段引用,详见响应提取。 测试阶段:测试步骤。 定义接口核心测试步骤,主要是对测试场景的详细描述,建议从
准备阶段(可选):前置步骤。 在此阶段中准备测试阶段需要的前置条件数据,如果没有前置条件,可以忽略此阶段。 如果前置条件的数据需要在测试阶段中引用,可以使用参数传递将数据参数化后,传递给测试阶段引用,详见响应提取。 测试阶段:测试步骤。 定义接口核心测试步骤,主要是对测试场景的详细描述,建议从
图标 为API资产设置一个图标。 资产简介 API资产的简单介绍,方便资产在API中心门户网站按描述被搜索。 使用指南 API资产的使用指导,帮助API调用者了解API的使用方法。 资产域名 API资产的域名。 分类 选择资产行业分类,方便API资产在API中心门户网站按行业类别被搜索。
图标 为API资产设置一个图标。 资产简介 API资产的简单介绍,方便资产在API中心门户网站按描述被搜索。 使用指南 API资产的使用指导,帮助API调用者了解API的使用方法。 资产域名 API资产的域名。 分类 选择资产行业分类,方便API资产在API中心门户网站按行业类别被搜索。
进度则会受到影响。 Mock服务能很好解决这些问题,使用场景如下: 并行开发:在被依赖模块未开发完成时,使用Mock服务替代真实业务服务场景,可进行并行开发。 依赖服务不稳定:当依赖服务不稳定时,会导致自动化测试用例失败,使用Mock服务替代真实服务,可以保证自动化测试稳定执行,提升流水线的健壮性。
进度则会受到影响。 Mock服务能很好解决这些问题,使用场景如下: 并行开发:在被依赖模块未开发完成时,使用Mock服务替代真实业务服务场景,可进行并行开发。 依赖服务不稳定:当依赖服务不稳定时,会导致自动化测试用例失败,使用Mock服务替代真实服务,可以保证自动化测试稳定执行,提升流水线的健壮性。
APIMock语法完全兼容Mock.js,并扩展了一些Mock.js没有的语法(uuid、正则表达式),Mock语法详见表1。 如现有Mock语法无法满足需求,建议使用正则表达式“@regexp”来实现灵活定制,正则表达式基本能满足各种特殊场景的需求。 表1 Mock语法 类型 函数 Basic
APIMock语法完全兼容Mock.js,并扩展了一些Mock.js没有的语法(uuid、正则表达式),Mock语法详见表1。 如现有Mock语法无法满足需求,建议使用正则表达式“@regexp”来实现灵活定制,正则表达式基本能满足各种特殊场景的需求。 表1 Mock语法 类型 函数 Basic
高级提取类型 可选项,使用高级提取类型,辅助提取响应结果信息,若选择不涉及则视为不使用额外的方式匹配。 目前有两种方式: 字符串提取,也就是字符串的截取。 正则表达式,即使用正则方式对来源字符串进行过滤。 高级提取类型优先使用字符串提取功能,若不能满足需求可考虑使用正则表达式。 赋值给环境动态参数
高级提取类型 可选项,使用高级提取类型,辅助提取响应结果信息,若选择不涉及则视为不使用额外的方式匹配。 目前有两种方式: 字符串提取,也就是字符串的截取。 正则表达式,即使用正则方式对来源字符串进行过滤。 高级提取类型优先使用字符串提取功能,若不能满足需求可考虑使用正则表达式。 赋值给环境动态参数
相应提示图标。 单击变更的API接口,在API“文档”页面单击“变更对比”。 弹出“变更对比”页面,可查看API接口变更前后的对比详情。 其他项目参与者有权限同步查看项目下任意API接口的变更详情。 提交审核 在API接口的“文档”页面单击“提交审核”,弹出“提交审核”页面,可查看接口变更前后的对比详情。
相应提示图标。 单击变更的API接口,在API“文档”页面单击“变更对比”。 弹出“变更对比”页面,可查看API接口变更前后的对比详情。 其他项目参与者有权限同步查看项目下任意API接口的变更详情。 提交审核 在API接口的“文档”页面单击“提交审核”,弹出“提交审核”页面,可查看接口变更前后的对比详情。
CodeArts API支持的系统权限如下: DevCloud Console ReadOnlyAccess:软件开发生产线控制台只读权限,授权后可正常使用CodeArts API产品,但不可创建项目。 DevCloud Console FullAccess:软件开发生产线控制台管理员权限,拥
API针对API做测试,更贴近API的设计、开发到测试的同步场景。 CodeArts TestPlan对整个项目做整体的测试计划与测试方案,更偏向测试场景使用。 接口自动化测试 接口自动化测试提供了丰富的用户可视化编辑页面,支持测试步骤编排,以及测试步骤的检查点和响应结果参数提取,帮助用户快速生
API针对API做测试,更贴近API的设计、开发到测试的同步场景。 CodeArts TestPlan对整个项目做整体的测试计划与测试方案,更偏向测试场景使用。 接口自动化测试 接口自动化测试提供了丰富的用户可视化编辑页面,支持测试步骤编排,以及测试步骤的检查点和响应结果参数提取,帮助用户快速生
例调用实现逻辑复用。 使用组合关键字高阶特性,需要特性使用授权,请联系客服处理。 具体请参考CodeArts Testplan的组合关键字。 接口自动化用例系统关键字 接口自动化测试将常见的操作封装成关键字供用户使用,用于提升编写接口测试用例的效率。 使用系统关键字高阶特性,需要