浏览器访问 访问CodeArts API产品官网首页,单击“网页版体验”,填写华为云账户密码进行登录,进入CodeArts API首页。 首次登录CodeArts API服务,系统将为用户默认创建示例项目,并进入项目,用户可基于项目中的示例接口认识API相关概念并熟悉产品使用方法。
浏览器访问 访问CodeArts API产品官网首页,单击“网页版体验”,填写华为云账户密码进行登录,进入CodeArts API首页。 首次登录CodeArts API服务,系统将为用户默认创建示例项目,并进入项目,用户可基于项目中的示例接口认识API相关概念并熟悉产品使用方法。
下载CodeArts API客户端 Windows 平台提供了桌面应用程序,可下载客户端,下载完成后解压文件,运行解压文件即可安装 CodeArts API 到您的电脑。 CodeArts API客户端下载地址如下表所示。 支持平台 下载地址 Windows latest_win
到API调试页面,本节介绍调试页面相关信息配置。 由于浏览器限制,使用CodeArts API的Web版本进行接口调试,需要先安装浏览器扩展,浏览器扩展请查看浏览器扩展。 接口路径 API调试页面的接口路径,可以选择http或https,并在定义的路径前自动添加了域名。添加的域名
下载CodeArts API客户端 Windows 平台提供了桌面应用程序,可下载客户端,下载完成后解压文件,运行解压文件即可安装 CodeArts API 到您的电脑。 CodeArts API客户端下载地址如下表所示。 支持平台 下载地址 Windows latest_win
英文逗号进行分隔。 身份认证 在选择“使用系统代理”与“自定义”代理两种代理模式时,支持配置身份认证信息。 开启配置身份认证开关后,CodeArts API需要重启客户端使身份认证信息配置生效。 输入用户名和密码(密码支持明文显示),然后单击“保存并重启CodeArts API”即可。
快速入门 使用CodeArts API快速设计并调试接口 访问CodeArts API产品首页,单击“网页版体验”,首次使用华为云账号登录CodeArts API的用户,系统将默认为该用户新建“示例项目”并进入项目,用户可基于示例接口认识API相关概念并熟悉产品使用方法。 使用API设计
I调试页面,本节介绍调试页面相关信息配置。 约束与限制 由于浏览器限制,使用CodeArts API的Web版本进行接口调试,需要先安装浏览器扩展,浏览器扩展请查看浏览器扩展。 接口路径 API调试页面的接口路径,可以选择http或https,并在定义的路径前自动添加了域名。添加
英文逗号进行分隔。 身份认证 在选择“使用系统代理”与“自定义”代理两种代理模式时,支持配置身份认证信息。 开启配置身份认证开关后,CodeArts API需要重启客户端使身份认证信息配置生效。 输入用户名和密码(密码支持明文显示),然后单击“保存并重启CodeArts API”即可。
选中需要发布的API,单击“下一步”。 在“选择运行时实例”的下拉框中选择需要注册的APIG实例,并配置实例参数。参数配置请参考APIG实例参数表。 APIG实例参数 参数 配置说明 API分组 在APIG实例上已创建的API集合,创建操作可参照创建API分组章节。 负载通道 是否使用负载通道。
虚拟用户SSO需要先登录一次CodeArts API,项目拥有者/项目经理才可以在成员管理页面中查询并添加该用户。 支持企业联邦账号登录并使用网页版CodeArts API,客户端暂不支持。 授权IAM账号 如果用户需要对所拥有的CodeArts API服务进行精细的权限管理,可以使用统一身份认证服务(Identity
选中需要发布的API,单击“下一步”。 在“选择运行时实例”的下拉框中选择需要注册的APIG实例,并配置实例参数。参数配置请参考APIG实例参数表。 APIG实例参数 参数 配置说明 API分组 在APIG实例上已创建的API集合,创建操作可参照创建API分组章节。 负载通道 是否使用负载通道。
按照身份转换规则授权。 两种身份提供商的适用场景及配置方法可参照身份供应商概述。 虚拟用户SSO需要先登录一次CodeArts API,项目拥有者/项目经理才可以在成员管理页面中查询并添加该用户。 支持企业联邦账号登录并使用网页版CodeArts API,客户端暂不支持。 父主题:
Mock规则设计 配置请求规则 请求Mock服务时,系统会根据规则中配置的参数匹配,只有规则下所有参数满足匹配条件时,才可匹配到整个规则。 请求参数,支持Query、Path、Header、Body。 Path参数只有在当前选择的接口的url中存在path变量时才可以显示配置。 Body
API支持将设计完成的接口推送至第三方URL。 单击“项目设置 > 导出数据”,默认进入“第三方推送”页签。 单击“新建”,弹出“新增同步任务”窗口。 配置任务参数,参数配置请参考下表。 参数 配置说明 任务名称 同步任务名称,只允许输入字母、汉字、数字、下划线、中划线,长度3-64个字符。 数据源格式 支持OpenAPI
API支持执行定时任务来导入API接口。 单击“项目设置 > 导入数据”,默认进入“定时导入”页签。 单击“新建”,弹出“新增定时任务”窗口。 配置任务参数,参数配置请参考下表。 参数 配置说明 任务名称 定时任务名称,只允许输入字母、汉字、数字、下划线、中划线,长度3-64个字符。 数据源格式 支持OpenApi格式。
API支持执行定时任务来导入API接口。 单击“项目设置 > 导入数据”,默认进入“定时导入”页签。 单击“新建”,弹出“新增定时任务”窗口。 配置任务参数,参数配置请参考下表。 参数 配置说明 任务名称 定时任务名称,只允许输入字母、汉字、数字、下划线、中划线,长度3-64个字符。 数据源格式 支持OpenApi格式。
Mock规则设计 配置请求规则 请求Mock服务时,系统会根据规则中配置的参数匹配,只有规则下所有参数满足匹配条件时,才可匹配到整个规则。 请求参数,支持Query、Path、Header、Body。 Path参数只有在当前选择的接口的url中存在path变量时才可以显示配置。 Body
发送HTTP/HTTPS的请求。 更多参数信息请查阅Collection SDK 文档 。 在前置脚本和后置脚本都可以使用。 更多参考: Request JSON 结构 Response 结构 // 使用字符串URL示例 pm.sendRequest("https://postman-echo
发送HTTP/HTTPS的请求。 更多参数信息请查阅Collection SDK 文档 。 在前置脚本和后置脚本都可以使用。 更多参考: Request JSON 结构 Response 结构 // 使用字符串URL示例 pm.sendRequest("https://postman-echo
您即将访问非华为云网站,请注意账号财产安全