检测到您已登录华为云国际站账号,为了您更好的体验,建议您访问国际站服务网站 https://www.huaweicloud.com/intl/zh-cn
不再显示此消息
API客户端支持离线使用,在登录客户端时,单击“稍后再说”,即可离线使用CodeArts API。但是离线状态下只支持使用默认环境及部分快捷调试功能,无法使用快捷调试中的导入、导出及脚本功能,且离线时快捷调试的接口与登录状态下不同步,具体离线使用操作请参照未登录使用客户端。 父主题: 功能相关
新建快捷调试 进入项目后,单击搜索框旁,可根据需要选择“新建快捷调试”或“导入Postman文件”进行快捷调试。 新建快捷调试 单击“新建快捷调试”,生成“快捷调试”页签。 输入接口完整URL,单击“发送”即可对已有接口进行快捷调试。 Params、Header、Cookies、Auth参数设计请参照API设计进行快速设计。
通过表单编辑和Swagger原生编辑器设计API,并利用API规范检查保证API设计质量。 API文档 自动生成API使用文档,支持API文档快速索引。 API开发 自动生成API前端SDK和后端框架代码。 API Mock 灵活模拟API调用响应。 API测试 灵活编排API测试用例,实时获取测试反馈。
通过表单编辑和Swagger原生编辑器设计API,并利用API规范检查保证API设计质量。 API文档 自动生成API使用文档,支持API文档快速索引。 API开发 自动生成API前端SDK和后端框架代码。 API Mock 灵活模拟API调用响应。 API测试 灵活编排API测试用例,实时获取测试反馈。
API全生命周期管理规范。 支持API规范自动检查、自动纠错,提升API设计质量。 自动化代码和用例生成 API SDK代码和服务框架代码与API设计同源,基于API文档一键生成代码。 API测试与API设计同源,设计示例一键导入测试步骤。 丰富的可扩展插件 运行时插件实现API
前置脚本 前置脚本是在请求发送前执行的代码片段。例如需要在请求头中生成时间戳、打印日志、设置随机参数值等。可以在接口的“前置脚本”页面中单击“添加前置操作 > 自定义脚本”,发送接口请求前将自动运行前置脚本。 打印日志 可以通过“console.log()”将需要的变量打印在控制台,用以查看某个变量的当前值。
前置脚本 前置脚本是在请求发送前执行的代码片段。例如需要在请求头中生成时间戳、打印日志、设置随机参数值等。可以在接口的“前置脚本”页面中单击“添加前置操作 > 自定义脚本”,发送接口请求前将自动运行前置脚本。 打印日志 可以通过“console.log()”将需要的变量打印在控制台,用以查看某个变量的当前值。
API全生命周期管理规范。 支持API规范自动检查、自动纠错,提升API设计质量。 自动化代码和用例生成 API SDK代码和服务框架代码与API设计同源,基于API文档一键生成代码。 API测试与API设计同源,设计示例一键导入测试步骤。 丰富的可扩展插件 运行时插件实现API
上限为10000字符,支持设置“敏感参数”、“动态参数” ,默认为否。 随机字符串 随机生成指定长度字符串,随机字符串的变量值长度校验范围【1-9999】,不支持设置“敏感参数”及“动态参数”。 随机整数 随机生成指定范围整数,区间范围校验为【-999999999~999999999】,不支持设置“敏感参数”及“动态参数”
在“API网关注册”页面,选择需要删除的API,单击“删除”。 弹出“删除警告”对话框,单击“确定”,完成API的删除。 删除失败会弹出“删除失败”对话框,提示失败原因。 删除在APIG实例中已发布的API,需要先在APIG实例中进行下线API操作,才可完成API的删除。 父主题: API发布
在“API网关注册”页面,选择需要删除的API,单击“删除”。 弹出“删除警告”对话框,单击“确定”,完成API的删除。 删除失败会弹出“删除失败”对话框,提示失败原因。 删除在APIG实例中已发布的API,需要先在APIG实例中进行下线API操作,才可完成API的删除。 父主题: API发布
上限为10000字符,支持设置“敏感参数”、“动态参数” ,默认为否。 随机字符串 随机生成指定长度字符串,随机字符串的变量值长度校验范围【1-9999】,不支持设置“敏感参数”及“动态参数”。 随机整数 随机生成指定范围整数,区间范围校验为【-999999999~999999999】,不支持设置“敏感参数”及“动态参数”
依赖服务不稳定:当依赖服务不稳定时,会导致自动化测试用例失败,使用Mock服务替代真实服务,可以保证自动化测试稳定执行,提升流水线的健壮性。 构造异常场景:测试时需要构造某些异常数据或延迟响应等异常场景,真实服务通常无法满足需求,使用Mock服务替代可以快速构造异常场景,提升测试覆盖率。
依赖服务不稳定:当依赖服务不稳定时,会导致自动化测试用例失败,使用Mock服务替代真实服务,可以保证自动化测试稳定执行,提升流水线的健壮性。 构造异常场景:测试时需要构造某些异常数据或延迟响应等异常场景,真实服务通常无法满足需求,使用Mock服务替代可以快速构造异常场景,提升测试覆盖率。
Body支持json和xml格式。当请求体为json格式时,匹配规则会同时匹配json中的key和value。 无法保存重复规则。如果同一个接口下的不同规则配置内容一致,会提示无法保存规则。 复杂规则匹配 Query、Path、Header支持复杂规则匹配,包括以下类型: <、<=、>、>=,支持类型:数字。
Body支持json和xml格式。当请求体为json格式时,匹配规则会同时匹配json中的key和value。 无法保存重复规则。如果同一个接口下的不同规则配置内容一致,会提示无法保存规则。 复杂规则匹配 Query、Path、Header支持复杂规则匹配,包括以下类型: <、<=、>、>=,支持类型:数字。
L请求等方式生成。 导入Swagger文件生成数据 在右侧“关键字库”界面,单击“导入接口”。 在弹出的“导入接口”页面,单击“点击添加文件或拖拽上传”,选择配置好的Swagger接口文档,单击“确定”,完成Swagger文件导入。 文档导入成功后,系统自动解析生成脚本模板,脚本
L请求等方式生成。 导入Swagger文件生成数据 在右侧“关键字库”界面,单击“导入接口”。 在弹出的“导入接口”页面,单击“点击添加文件或拖拽上传”,选择配置好的Swagger接口文档,单击“确定”,完成Swagger文件导入。 文档导入成功后,系统自动解析生成脚本模板,脚本
collection功能可以通过使用CodeArts API的API测试实现,支持接口的自动化测试,可视化界面灵活编排测试用例顺序,无需修改脚本,实现“零代码”快速生成测试用例,具体API测试操作可参照API测试导读。 父主题: 功能相关
带您熟悉CodeArts API中的API设计审核 02:27 API设计审核 CodeArts API 介绍如何通过CodeArts API的自动化代码生成能力进行API开发 01:10 API开发 CodeArts API 介绍如何在CodeArts API进行API自动化测试 03:39 API测试