检测到您已登录华为云国际站账号,为了您更好的体验,建议您访问国际站服务网站 https://www.huaweicloud.com/intl/zh-cn
不再显示此消息
后置脚本是在请求发送后执行的代码片段,主要用于验证请求返回的结果(断言)、将请求返回的结果数据写入环境变量等场景。可以在接口的“后置脚本”页面中单击“添加后置操作”,发送接口请求后将自动运行后置脚本。 断言 可以利用后置脚本验证API响应返回结果的正确性。 // 示例1:pm.response.to.have pm.test('Response
云端Mock的优势: Mock数据统一管理 配置数据团队共享 单击项目名称,进入目标项目,单击“项目设置 > 功能设置”,默认选择Mock设置页签,选择“开放访问”或“Token鉴权”,即可设置云端Mock访问权限。 父主题: API Mock
导入通过Postman导出的文件时,接口示例会被同时导入为快捷调试接口,名称和Postman中接口示例名称相同。 单击“导入”,导入成功后可直接单击“发送”进行调试,也可保存为接口。 使用API设计 单击“API设计”模块,可以看到示例项目中已经预设了不同请求的API示例和公共模型。 在“API设计”模块,单击任意接口,如“查询产品列表”。
前置脚本 前置脚本是在请求发送前执行的代码片段。例如需要在请求头中生成时间戳、打印日志、设置随机参数值等。可以在接口的“前置脚本”页面中单击“添加前置操作 > 自定义脚本”,发送接口请求前将自动运行前置脚本。 打印日志 可以通过“console.log()”将需要的变量打印在控制台,用以查看某个变量的当前值。
前置脚本 前置脚本是在请求发送前执行的代码片段。例如需要在请求头中生成时间戳、打印日志、设置随机参数值等。可以在接口的“前置脚本”页面中单击“添加前置操作 > 自定义脚本”,发送接口请求前将自动运行前置脚本。 打印日志 可以通过“console.log()”将需要的变量打印在控制台,用以查看某个变量的当前值。
允许同名API重复注册。 注册API后需要到APIG实例中完成发布API操作,才可完成API的上线。 API重新注册 CodeArts API提供API重新注册的功能,协助用户将已修改或不同版本的API重新注册到APIG实例。 在“API网关注册”页面,光标移动到API版本,可查看当前API的注册信息。
使用CodeArts API快速设计并调试接口 访问CodeArts API产品首页,单击“网页版体验”,首次使用华为云账号登录CodeArts API的用户,系统将默认为该用户新建“示例项目”并进入项目,用户可基于示例接口认识API相关概念并熟悉产品使用方法。 使用API设计 示例项目
云端Mock的优势: Mock数据统一管理 配置数据团队共享 单击项目名称,进入目标项目,单击“项目设置 > 功能设置”,默认选择Mock设置页签,选择“开放访问”或“Token鉴权”,即可设置云端Mock访问权限。 父主题: API Mock
允许同名API重复注册。 注册API后需要到APIG实例中完成发布API操作,才可完成API的上线。 API重新注册 CodeArts API提供API重新注册的功能,协助用户将已修改或不同版本的API重新注册到APIG实例。 在“API网关注册”页面,光标移动到API版本,可查看当前API的注册信息。
在弹出的“从【接口用例】导入(推荐)”对话框上,选择需要导入的接口,即“API设计”中接口的调试用例,参考保存为用例。 单击“导入”,完成测试步骤添加。 从【接口】导入 在弹出的“从【接口】导入”对话框上,选择需要导入的接口,即“API设计”的接口数据。 单击“导入”,完成测试步骤添加。
在弹出的“从【接口用例】导入(推荐)”对话框上,选择需要导入的接口,即“API设计”中接口的调试用例,参考保存为用例。 单击“导入”,完成测试步骤添加。 从【接口】导入 在弹出的“从【接口】导入”对话框上,选择需要导入的接口,即“API设计”的接口数据。 单击“导入”,完成测试步骤添加。
编辑模式与API规范检查 CodeArts API在API设计界面提供代码编辑模式进行API设计,可使用yaml格式设计接口文档。在编辑模式中CodeArts API提供API规范性检查。 通过规范性检查功能,可以形成统一的设计规范,避免API设计不一致,提高API设计质量。AP
局部参数引用形式为“${参数名}”,如:参数名为“hostIp”,则可以使用“${hostIp}”来引用该参数。 局部参数主要配置项如下: 配置项 是否必填 描述 名称 是 支持中英文、数字、点号、中文短横线、下划线的半角字符,并且长度范围是1~300。 类型 是 支持文本、
兼容Postman脚本语法,可以在CodeArts API中直接运行Postman脚本。 Postman中Run collection功能可以通过使用CodeArts API的API测试实现,支持接口的自动化测试,可视化界面灵活编排测试用例顺序,无需修改脚本,实现“零代码”快速生成测试用例,具体API测试操作可参照API测试导读。
局部参数引用形式为“${参数名}”,如:参数名为“hostIp”,则可以使用“${hostIp}”来引用该参数。 局部参数主要配置项如下: 配置项 是否必填 描述 名称 是 支持中英文、数字、点号、中文短横线、下划线的半角字符,并且长度范围是1~300。 类型 是 支持文本、
编辑模式与API规范检查 CodeArts API在API设计界面提供代码编辑模式进行API设计,可使用yaml格式设计接口文档。在编辑模式中CodeArts API提供API规范性检查。 通过规范性检查功能,可以形成统一的设计规范,避免API设计不一致,提高API设计质量。AP
导入Swagger文件生成数据 在右侧“关键字库”界面,单击“导入接口”。 在弹出的“导入接口”页面,单击“点击添加文件或拖拽上传”,选择配置好的Swagger接口文档,单击“确定”,完成Swagger文件导入。 文档导入成功后,系统自动解析生成脚本模板,脚本模板包含了接口的基本描述信息。可以从“关键字库”界
导入Swagger文件生成数据 在右侧“关键字库”界面,单击“导入接口”。 在弹出的“导入接口”页面,单击“点击添加文件或拖拽上传”,选择配置好的Swagger接口文档,单击“确定”,完成Swagger文件导入。 文档导入成功后,系统自动解析生成脚本模板,脚本模板包含了接口的基本描述信息。可以从“关键字库”界
CodeArts API是否支持离线使用? CodeArts API客户端支持离线使用,在登录客户端时,单击“稍后再说”,即可离线使用CodeArts API。但是离线状态下只支持使用默认环境及部分快捷调试功能,无法使用快捷调试中的导入、导出及脚本功能,且离线时快捷调试的接口与登录状态下
访问客户端 登录使用 单击“登录/注册”,填写华为云账户密码进行登录。 首次登录CodeArts API服务,系统将为用户默认创建示例项目,并进入项目,用户可基于项目中的示例接口认识API相关概念并熟悉产品使用方法。 未登录使用 打开客户端,在登录页面单击“稍后再说”即可开始使用。未