检测到您已登录华为云国际站账号,为了您更好的体验,建议您访问国际站服务网站 https://www.huaweicloud.com/intl/zh-cn
不再显示此消息
sendRequest pm.sendRequest:Function用于脚本异步发送HTTP/HTTPS的请求。 更多参数信息请查阅Collection SDK 文档 。 在前置脚本和后置脚本都可以使用。 更多参考: Request JSON 结构 Response 结构 // 使用字符串URL示例
单击“API设计”模块,可以看到示例项目中已经预设了不同请求的API示例和公共模型。 在“API设计”模块,单击任意接口,如“查询产品列表”。 默认进入“文档”页签,可通过右侧文档目录切换页面。 单击“设计”页签可以进入API设计页面,操作可参照API设计章节。 单击“调试”页签进入调试页面,操作可参照示例接口调试。
数据结构被引用后,可以在数据结构的文档页面查看引用当前数据结构的API和模型。 公共响应 接口的公共响应返回结果,响应类型默认为“application/json”结构。 在设计API的响应体时,可以直接引用已设计好的公共响应。 公共响应文档页面可以查看引用当前公共响应的API。
数据结构被引用后,可以在数据结构的文档页面查看引用当前数据结构的API和模型。 公共响应 接口的公共响应返回结果,响应类型默认为“application/json”结构。 在设计API的响应体时,可以直接引用已设计好的公共响应。 公共响应文档页面可以查看引用当前公共响应的API。
在接口的快捷调试页面单击,选择“保存为接口”。 在“保存为接口”页面输入接口名称,选择接口目录,单击“确定”,保存接口。 单击“API设计”,选择保存的接口,默认进入接口的文档页签。 单击“生成代码”下拉框,获取接口代码,具体操作请参照API开发。 父主题: 功能相关
相应提示图标。 单击变更的API接口,在API“文档”页面单击“变更对比”。 弹出“变更对比”页面,可查看API接口变更前后的对比详情。 其他项目参与者有权限同步查看项目下任意API接口的变更详情。 提交审核 在API接口的“文档”页面单击“提交审核”,弹出“提交审核”页面,可查看接口变更前后的对比详情。
相应提示图标。 单击变更的API接口,在API“文档”页面单击“变更对比”。 弹出“变更对比”页面,可查看API接口变更前后的对比详情。 其他项目参与者有权限同步查看项目下任意API接口的变更详情。 提交审核 在API接口的“文档”页面单击“提交审核”,弹出“提交审核”页面,可查看接口变更前后的对比详情。
API文档 API设计完成后,单击“保存”,会自动跳转到API文档页面。如果单击左侧导航栏中的API,默认进入API文档页面。 API文档页面展示了定义好的API信息,包括API路径、请求参数、请求体、返回响应等信息,可通过右侧文档目录切换至对应模块进行查看。在文档展示页面,
API文档 API设计完成后,单击“保存”,会自动跳转到API文档页面。如果单击左侧导航栏中的API,默认进入API文档页面。 API文档页面展示了定义好的API信息,包括API路径、请求参数、请求体、返回响应等信息,可通过右侧文档目录切换至对应模块进行查看。在文档展示页面,
户下用户。 华为云目前支持以下两种身份提供商类型: IAM用户SSO:身份提供商中的用户登录华为云后,系统将自动匹配外部身份ID绑定的对应IAM子用户,从而拥有该子用户所在用户组的权限。此类型账号与普通的IAM账号授权相同。 虚拟用户SSO:身份提供商中的用户登录华为云后,系统为
户下用户。 华为云目前支持以下两种身份提供商类型: IAM用户SSO:身份提供商中的用户登录华为云后,系统将自动匹配外部身份ID绑定的对应IAM子用户,从而拥有该子用户所在用户组的权限。此类型账号与普通的IAM账号授权相同。 虚拟用户SSO:身份提供商中的用户登录华为云后,系统为
认证方式 选择认证方式: 无认证:表示不需要认证。 华为云APIG-AKSK认证:通过AK(Access Key ID)/SK(Secret Access Key)加密调用请求,关于AK/SK获取方式请参照AK/SK认证。 华为云APIG-简易认证:通过AppCode简易认证方式
认证方式 选择认证方式: 无认证:表示不需要认证。 华为云APIG-AKSK认证:通过AK(Access Key ID)/SK(Secret Access Key)加密调用请求,关于AK/SK获取方式请参照AK/SK认证。 华为云APIG-简易认证:通过AppCode简易认证方式
后端开发时长,规范代码结构。 基于接口定义,CodeArts API支持自动生成各种语言和框架的请求代码和业务代码。在API设计模块,接口文档界面右侧,即可看到“生成代码”的入口。 生成接口请求代码 单击“生成代码”下拉框,选择“生成接口请求代码”,弹出“生成接口请求代码”对话框。
后端开发时长,规范代码结构。 基于接口定义,CodeArts API支持自动生成各种语言和框架的请求代码和业务代码。在API设计模块,接口文档界面右侧,即可看到“生成代码”的入口。 生成接口请求代码 单击“生成代码”下拉框,选择“生成接口请求代码”,弹出“生成接口请求代码”对话框。
API服务,限制人数50人。 “API测试”的“测试用例”与“测试套件”,集成了CodeArts TestPlan的“接口自动化测试”与“测试执行”两个特性,均需要在华为云执行机上执行,因此属于付费特性,用户需要开通CodeArts的付费套餐或CodeArts TestPlan套餐后方可使用,具体请参照CodeArts
浏览器访问 访问CodeArts API产品官网首页,单击“网页版体验”,填写华为云账户密码进行登录,进入CodeArts API首页。 首次登录CodeArts API服务,系统将为用户默认创建示例项目,并进入项目,用户可基于项目中的示例接口认识API相关概念并熟悉产品使用方法。
什么是CodeArts API CodeArts API是华为云API全生命周期管理一体化解决方案平台,支持开发者高效实现API设计、API开发、API测试、API托管、API运维、API变现的一站式体验。通过以API契约为锚点,CodeArts API保证API各阶段数据高度一
浏览器访问 访问CodeArts API产品官网首页,单击“网页版体验”,填写华为云账户密码进行登录,进入CodeArts API首页。 首次登录CodeArts API服务,系统将为用户默认创建示例项目,并进入项目,用户可基于项目中的示例接口认识API相关概念并熟悉产品使用方法。
API调试 完成API设计之后,在API文档页面单击“运行”会自动切换到API调试页面,也可以单击“调试”页签切换到API调试页面,本节介绍调试页面相关信息配置。 约束与限制 由于浏览器限制,使用CodeArts API的Web版本进行接口调试,需要先安装浏览器扩展,浏览器扩展请查看浏览器扩展。