【智简网络】如何使用API Explorer

如何使用API Explorer

API Explorer是一个API体验平台，提供API信息概览、SDK向导，以及API在线模拟调试。你可以在这里去体验各种API使用场景。

一、登录

步骤1：通过https://developer.huaweicloud.cn/techfield/network.html智简网络界面，进入“API Explorer”工具界面。

步骤2：选择你想体验不同域中不同业务下API类型的卡片，进入体验。

步骤3：选择”基础网络”，查看iMaster NCE-Campus 北向API接口场景，单击“用户管理”类型，选择API接口类型。

补充说明：

• 查看文档：查看API参考文档；

• 示例代码：在“在线调试”区域填写请求参数后自动生成右侧的示例代码；

• 数据模拟：模拟真实API不同返回状态的响应示例；

• 调试结果：用户登录并执行后，对当前账户的模拟资源发起线上调试。

二、体验操作流程

方式一：在线模拟Demo环境体验

线上提供一套模拟环境，你可以直接输入参数值，则可以体验API接口。

步骤1：在“在线调试”模块，输入参数（提供配置好的参数值），单击”执行”， 就可以在“调试结果”查看是否成功。

结果1：当“Response”字段，显示数值为200，则代表参数成功。

结果2：如果数值显示为400或500，代表参数错误。

方式二：实际操作（一）

当用户没有本地环境去体验时，可以在远程实验室中预约一个环境，就能体验API Explorer中的接口。

步骤1：根据搭建方法参考Java/Python SDK向导，搭建一套Java/Python SDK工程。

步骤2：进入远程实验室，预约环境，成功后，单击“体验”。

步骤3：单击“iMaster NCE-Campus”图标，右侧出现“资源结构模块”，拷贝“IP”和“port”值。

步骤4：单击 “示例代码”，在Java/Python代码中输入上一步“host”和“port”值，并打包，在创建好的SDK工程去调用即可。

补充说明：

关于远程实验室预约环境的操作，可以通过https://bbs.huaweicloud.cn/forum/forum.php?mod=viewthread&tid=91480此链接了解。

方式二：实际操作（二）

当用户提供本地环境，可以直接去体验API接口。

步骤1：根据搭建方法参考Java/Python SDK向导，搭建一套Java/Python SDK工程。

步骤2：单击 “示例代码”，在Java/Python代码中输入“host”和“port”（用户本地环境），并打包成，在创建好的SDK工程去调用即可。