检测到您已登录华为云国际站账号,为了您更好的体验,建议您访问国际站服务网站 https://www.huaweicloud.com/intl/zh-cn
不再显示此消息
准备工作 在使用API网关注册功能前,用户需要先购买APIG实例。如果没有购买过APIG实例,可以在CodeArts API上通过以下操作步骤完成购买。 单击“项目设置 > 插件管理”,进入“插件管理”页面。 单击“购买运行时实例”,在弹出的填写购买实例页面,配置实例参数,具体可参照购买实例章节,完成购买。
准备工作 在使用API网关注册功能前,用户需要先购买APIG实例。如果没有购买过APIG实例,可以在CodeArts API上通过以下操作步骤完成购买。 单击“项目设置 > 插件管理”,进入“插件管理”页面。 单击“购买运行时实例”,在弹出的填写购买实例页面,配置实例参数,具体可参照购买实例章节,完成购买。
项目概况 进入CodeArts API目标项目后,默认进入项目概况页面,可查看项目下数据统计及API集合情况。 父主题: API设计
项目概况 进入CodeArts API目标项目后,默认进入项目概况页面,可查看项目下数据统计及API集合情况。 父主题: API设计
在“审核设置”页签,审核设置按钮默认为关闭状态,单击,开启审核功能。 开启审核功能后,在项目下API设计中创建、删除、修改API的操作均会被记录为草稿内容,需要通过审核后生效。 关闭审核功能 在“审核设置”页签,单击,弹出“审核设置”对话框。 根据提示输入“CLOSE”后,单击“确定”,关闭审核功能。
在“审核设置”页签,审核设置按钮默认为关闭状态,单击,开启审核功能。 开启审核功能后,在项目下API设计中创建、删除、修改API的操作均会被记录为草稿内容,需要通过审核后生效。 关闭审核功能 在“审核设置”页签,单击,弹出“审核设置”对话框。 根据提示输入“CLOSE”后,单击“确定”,关闭审核功能。
”,且以中英文开头,长度为3-64个字符。 正文:可手动输入文字,也可使用组件插入特定的内容,如:表格、超链接、图片;正文样式也可以使用组件进行调整;正文编辑支持全屏模式;在左侧编辑正文时,右侧会同步展示编辑内容,便于查看、修改样式等。 编辑完成后,单击右上角“保存”,左侧目录树同步刷新,
”,且以中英文开头,长度为3-64个字符。 正文:可手动输入文字,也可使用组件插入特定的内容,如:表格、超链接、图片;正文样式也可以使用组件进行调整;正文编辑支持全屏模式;在左侧编辑正文时,右侧会同步展示编辑内容,便于查看、修改样式等。 编辑完成后,单击右上角“保存”,左侧目录树同步刷新,
API客户端支持离线使用,在登录客户端时,单击“稍后再说”,即可离线使用CodeArts API。但是离线状态下只支持使用默认环境及部分快捷调试功能,无法使用快捷调试中的导入、导出及脚本功能,且离线时快捷调试的接口与登录状态下不同步,具体离线使用操作请参照未登录使用客户端。 父主题: 功能相关
SDK代码和服务框架代码与API设计同源,基于API文档一键生成代码。 API测试与API设计同源,设计示例一键导入测试步骤。 丰富的可扩展插件 运行时插件实现API一键托管,保障API高安全、高可用、高并发调用。 便捷API资产开放 提供便捷式的API资产管理,一键发布到API中心快速实现资产变现。
熟悉产品使用方法。 未登录使用 打开客户端,在登录页面单击“稍后再说”即可开始使用。未登录的状态下只支持创建一个环境及使用部分快捷调试功能。 创建环境 创建环境及环境变量请参照环境与环境变量进行设置与使用。 快捷调试 进入项目后,单击搜索框旁,可根据需要选择“新建快捷调试”进行新建快捷调试操作。
试自动化、节约潜在的成本和进度等方面。在设计测试用例时,经常会遇到一些相同的前置步骤或者测试逻辑。如果每一个测试用例中都编写这些步骤,重复工作量很大,并且难以维护。测试关键字可以帮助复用这些测试步骤。 关键字库将接口关键字、组合关键字、系统关键字进行统一管理,打造一站式关键字管理
试自动化、节约潜在的成本和进度等方面。在设计测试用例时,经常会遇到一些相同的前置步骤或者测试逻辑。如果每一个测试用例中都编写这些步骤,重复工作量很大,并且难以维护。测试关键字可以帮助复用这些测试步骤。 关键字库将接口关键字、组合关键字、系统关键字进行统一管理,打造一站式关键字管理
SDK代码和服务框架代码与API设计同源,基于API文档一键生成代码。 API测试与API设计同源,设计示例一键导入测试步骤。 丰富的可扩展插件 运行时插件实现API一键托管,保障API高安全、高可用、高并发调用。 API一键注册到网关 实现API一键发布到运行时插件APIG(云原生网关),确保API开发态与运行态的一致性。
角色与操作权限说明 CodeArts API服务各用户角色类型及对应的操作权限说明如下: 表1 通用设置默认角色权限说明 服务资源 权限 权限说明 项目管理员 项目经理 产品经理 测试经理 运维经理 系统工程师 Committer 开发人员 测试人员 参与者 浏览者 角色 权限设置
支持区域: 北京四 Mock规则管理 Mock规则设计 Mock语法说明 API测试 API测试与API设计同源,设计示例一键导入测试步骤。 测试步骤免编辑一键导入,测试数据契约化自动同步。 测试参数、断言、数据提取可视化编辑。 测试环境一键灵活切换,测试生产环境用例同源。 测试结果实时一体化呈现,用例脚本即测即改。
角色与操作权限说明 CodeArts API服务各用户角色类型及对应的操作权限说明如下: 表1 通用设置默认角色权限说明 服务资源 权限 权限说明 项目管理员 项目经理 产品经理 测试经理 运维经理 系统工程师 Committer 开发人员 测试人员 参与者 浏览者 角色 权限设置
动态参数的值可以在用例执行过程中被赋值。动态参数初始值可为空,被赋值之后,此处显示的是最新值。 动态参数赋值方法:在用例测试步骤“响应提取”的“赋值给环境动态参数”中设置后,测试执行时,响应提取的内容将被赋值给动态参数。 变量搜索 CodeArts API支持在当前环境下搜索变量,可以根据如下条件搜索:
动态参数的值可以在用例执行过程中被赋值。动态参数初始值可为空,被赋值之后,此处显示的是最新值。 动态参数赋值方法:在用例测试步骤“响应提取”的“赋值给环境动态参数”中设置后,测试执行时,响应提取的内容将被赋值给动态参数。 变量搜索 CodeArts API支持在当前环境下搜索变量,可以根据如下条件搜索:
支持区域: 北京四、上海一 Mock规则管理 Mock规则设计 Mock语法说明 API测试 API测试与API设计同源,设计示例一键导入测试步骤。 测试步骤免编辑一键导入,测试数据契约化自动同步。 测试参数、断言、数据提取可视化编辑。 测试环境一键灵活切换,测试生产环境用例同源。 测试结果实时一体化呈现,用例脚本即测即改。