检测到您已登录华为云国际站账号,为了您更好的体验,建议您访问国际站服务网站 https://www.huaweicloud.com/intl/zh-cn
不再显示此消息
API调试 完成API设计之后,在API文档页面单击“运行”会自动切换到API调试页面,也可以单击“调试”页签切换到API调试页面,本节介绍调试页面相关信息配置。 由于浏览器限制,使用CodeArts API的Web版本进行接口调试,需要先安装浏览器扩展,浏览器扩展请查看浏览器扩展。
选项中的“新建API接口”,创建http类型接口。 设计API 接口文档应针对以下要素进行设计: 接口基本信息 接口路径 请求方式 接口请求参数 接口返回响应 安全方案 接口基本信息 填写接口的基本信息,包括: 名称:接口名称。 摘要:接口的摘要信息。 状态:API生命周期的状态
选项中的“新建API接口”,创建http类型接口。 设计API 接口文档应针对以下要素进行设计: 接口基本信息 接口路径 请求方式 接口请求参数 接口返回响应 安全方案 接口基本信息 填写接口的基本信息,包括: 名称:接口名称。 摘要:接口的摘要信息。 状态:API生命周期的状态
API脚本能力仅限于快捷调试、接口调试、接口调试用例。 接口的前置脚本与后置脚本支持配置多个,并按照配置顺序执行。 CodeArts API支持脚本输入提示。 父主题: 脚本能力
API脚本能力仅限于快捷调试、接口调试、接口调试用例。 接口的前置脚本与后置脚本支持配置多个,并按照配置顺序执行。 CodeArts API支持脚本输入提示。 父主题: 脚本能力
API开发 CodeArts API支持生成接口请求代码和业务代码,缩短前后端开发时长,规范代码结构。 基于接口定义,CodeArts API支持自动生成各种语言和框架的请求代码和业务代码。在API设计模块,接口文档界面右侧,即可看到“生成代码”的入口。 生成接口请求代码 单击“
API开发 CodeArts API支持生成接口请求代码和业务代码,缩短前后端开发时长,规范代码结构。 基于接口定义,CodeArts API支持自动生成各种语言和框架的请求代码和业务代码。在API设计模块,接口文档界面右侧,即可看到“生成代码”的入口。 生成接口请求代码 单击“
API测试导读 API测试能力简介 CodeArts API的“API测试”功能来源于CodeArts TestPlan的“接口自动化测试”能力,且与CodeArts TestPlan的数据同源。 CodeArts API针对API做测试,更贴近API的设计、开发到测试的同步场景。
API测试导读 API测试能力简介 CodeArts API的“API测试”功能来源于CodeArts TestPlan的“接口自动化测试”能力,且与CodeArts TestPlan的数据同源。 CodeArts API针对API做测试,更贴近API的设计、开发到测试的同步场景。
在测试步骤请求中可以设置请求结果的检查点,方便用户检测当前接口的返回值,验证测试步骤是否得到预期结果。 设置建议 推荐用户设置检查点。针对接口类请求,请提供判断响应码的检查点。 当检查点设置为空,不论接口的响应码是什么,都会判断结果为成功。 检查点说明 测试检查点即请求结果的断言,通过检查接口响应是否符合预期,判定系统是否满足预期。
页面或接口级高级Mock页面。 目录级Mock规则管理页面 单击“API设计”,然后单击接口目录右侧的,选择“Mock规则管理”。 进入“Mock规则管理”页面,可以查看当前目录下所有接口和接口对应的Mock规则。 接口级高级Mock页面 单击“API设计”,选择对应的接口。 单
页面或接口级高级Mock页面。 目录级Mock规则管理页面 单击“API设计”,然后单击接口目录右侧的,选择“Mock规则管理”。 进入“Mock规则管理”页面,可以查看当前目录下所有接口和接口对应的Mock规则。 接口级高级Mock页面 单击“API设计”,选择对应的接口。 单
在测试步骤请求中可以设置请求结果的检查点,方便用户检测当前接口的返回值,验证测试步骤是否得到预期结果。 设置建议 推荐用户设置检查点。针对接口类请求,请提供判断响应码的检查点。 当检查点设置为空,不论接口的响应码是什么,都会判断结果为成功。 检查点说明 测试检查点即请求结果的断言,通过检查接口响应是否符合预期,判定系统是否满足预期。
pm对象API参考 pm pm:Object pm对象,含有接口运行关联信息。可利用它获取或设置环境变量和全局变量,且访问请求信息和返回结果信息。 pm:info:Object pm.info对象,含有接口运行关联信息。 pm.info.eventName:String:获取当前
pm对象API参考 pm pm:Object pm对象,含有接口运行关联信息。可利用它获取或设置环境变量和全局变量,且访问请求信息和返回结果信息。 pm:info:Object pm.info对象,含有接口运行关联信息。 pm.info.eventName:String:获取当前
在选择“使用系统代理”与“自定义”代理两种代理模式时,支持配置身份认证信息。 开启配置身份认证开关后,CodeArts API需要重启客户端使身份认证信息配置生效。 输入用户名和密码(密码支持明文显示),然后单击“保存并重启CodeArts API”即可。 父主题: 客户端访问
在选择“使用系统代理”与“自定义”代理两种代理模式时,支持配置身份认证信息。 开启配置身份认证开关后,CodeArts API需要重启客户端使身份认证信息配置生效。 输入用户名和密码(密码支持明文显示),然后单击“保存并重启CodeArts API”即可。 父主题: 客户端访问
浏览器访问 访问CodeArts API产品官网首页,单击“网页版体验”,填写华为云账户密码进行登录,进入CodeArts API首页。 首次登录CodeArts API服务,系统将为用户默认创建示例项目,并进入项目,用户可基于项目中的示例接口认识API相关概念并熟悉产品使用方法。 浏览器扩展
浏览器访问 访问CodeArts API产品官网首页,单击“网页版体验”,填写华为云账户密码进行登录,进入CodeArts API首页。 首次登录CodeArts API服务,系统将为用户默认创建示例项目,并进入项目,用户可基于项目中的示例接口认识API相关概念并熟悉产品使用方法。 浏览器扩展
后置脚本是在请求发送后执行的代码片段,主要用于验证请求返回的结果(断言)、将请求返回的结果数据写入环境变量等场景。可以在接口的“后置脚本”页面中单击“添加后置操作”,发送接口请求后将自动运行后置脚本。 断言 可以利用后置脚本验证API响应返回结果的正确性。 // 示例1:pm.response.to.have pm.test('Response