[信息速递] 教你一招:如何快速上手API Studio?

1 工具概述

API Studio基于iMaster NCE提供的北向开放能力,为广大开发者提供场景化的API调用示例和Restful接口调测环境。

API Studio功能概述如下:

  1. 提供设置API参数的可视化界面。

  2. 支持拖拽公共组件和API组件构建成场景化API调用的流程图。

  3. 支持用户推送模板。用户可将自己设计的流程推送到管理员。管理员将此作为公共模板发布后,其他开发者可共享。

  4. 支持用户导出基于某个流程的Java代码示例。

  5. 支持导入本地流程/导出流程到本地。

  6. 支持导出流程运行结果到本地。

工具体验地址:https://devzone.huawei.com/flowchart/index.jsp

2 快速上手API Studio

介绍API Studio的基本操作流程,帮助您快速上手API Studio。

注册账号

  1. 进入API Studio工具,在账号登录页面,单击“免费注册”。

  2. 设置手机号并单击“获取短信验证码”。

    1.png

  • 该手机号未注册过华为云账号,或已注册过华为云账号,但账号数量未达到系统允许的最大数量。

    输入短信验证码、密码并勾选“我已阅读并同意《华为云用户协议》和《隐私政策声明》”。

  • 该手机号已注册过华为云账号,且账号数量已达到系统允许的最大数量

    将不支持再使用该手机号注册新的华为云账号。

  • 单击“同意协议并注册”。

    账号提示注册成功。

  •         编排流程

    场景化API调用流程示例:查询站点site1,若存在则查询site1站点下的设备列表,若不存在则创建站点site1。下面以该示例说明流程编排步骤:

    1. 拖动左侧组件到中间流程编辑面板。

      图2-1所示,拖动左侧开始组件至流程编辑面板,其余组件类似操作。

      图2-1 拖动组件示例图2.png
    2. 单击组件,然后单击3.png并拖动至目的组件进行连接。

      双击连接线可对其进行命名。

      单击组件后,在右侧参数设置面板的label字段中可对组件进行重命名。

      4.png

    3. 设置“查询站点”参数信息。

      outbound为节点响应结果别名,供目的节点调用。这里设置为getsite。

      name为站点名称,是查询站点接口的请求参数。这里设置为site1。

      单击“查看Yaml文件”,可查看接口的详情信息,包括典型场景、接口功能、接口约束、请求和响应参数。

      5.png

    4. 设置“boolean”参数信息。

      左值leftParam为判断参数值。这里leftParam设置为${getsite.response.data.0.name},表明需要作出判断的参数取自getsite的name值,即调用查询站点接口后返回的站点名称。

      note_3.0-zh-cn.png

      ${getsite.response}为调用查询站点接口返回值:

      {   "errcode": "200",   
          "errmsg": "",  
          "totalRecords": 2,   
          "pageIndex": 0,  
          "pageSize": 20,  
          "data": [     
            {      
              "id": "ec083842-2471-4bcb-a329-0730b7cc5500",        "tenantId": "",   
              "name": "site1",      
              "description": "description1",  
              "type": [     
                "AP"
               ]    
            }   
          ] 
      }

      则${getsite.response.data.0.name}取值为模糊查询后符合条件的第一个name值。若返回值有多个,可使用${getsite.response.data.?.name}取所有的name值。

      右值rightParam为目标参数值。这里设置为site1。

      oper为判断条件。这里设置为“=”,若leftParam=rightParam,流程运行true分支。否则,流程运行false分支。

      6.png

    5. 设置“查询设备”参数信息。

      outbound设置为getdevice。

      siteId为站点ID,可查询该站点下的设备列表。这里设置为${getsite.response.data.0.id},取自查询站点接口返回的站点ID。

      7.png

    6. 设置“创建站点”参数信息。

      outbound设置为createsite。

      单击“编辑”设置body参数。

      8.png

    7. 单击“拓扑属性”,填写必填字段网络协议、IP地址和端口号。

      如果需要自定义字段,可输入名称和值后单击9.png添加。

      勾选“是否显示”后,可在界面显示拓扑属性页签。

      拓扑属性设置完成后,单击“应用”。

      10.png

    8. 单击“文件 > 保存”,或者按快捷键“Ctrl+S”。

    9. 单击右上角菜单栏“运行视图”,切换至运行视图。

      11.png

    10. 单击“运行”。

      12.png

      组件变为绿色代表运行通过,红色代表运行出错,黄色代表该API无法运行。

      13.png

    11. 单击“导出 > 导出运行结果”。

      14.png

    12. 填写文件名称,选择流程图名称、开始和结束时间后,单击“确定”。

      若开始和结束时间为空,则导出所有时间段执行的运行结果。

      15.png

    13. 查看运行结果。

      16.png

    3 通用操作

    介绍API Studio的通用操作,帮助您了解更多API Studio使用技巧。

    导入工程文件

    导入本地的.apis工程文件后,打开已有的场景化API调用的流程图。

    1. 单击“文件 > 导入工程文件”。

      17.png

    2. 在“导入工程文件”弹出框中,单击“文件选择”。

      18.png

    3. 导入.apis文件后,单击“导入”。

      19.png

    导出工程文件

    保存已编排的流程后,支持导出该流程的.apis工程文件到本地。

    1. 单击“文件 > 导出工程文件”。

    20.png

    2. 提示“导出成功!”弹出框中,单击“确定”。

    21.png

    导入流程图

    已保存的流程图都存放在工作空间中,支持获取工作空间中已保存的流程图。

    1. 单击“文件 > 从工作空间导入”。

      22.png

    2. 单击操作列的23.png,打开工作空间中保存的流程图。

      24.png

    导出静态配置

    支持导出流程的html配置页面信息。

    1. 单击“文件 > 导出静态配置”,导出为html.zip文件。

      25.png

    2. 下载到本地并解压后,双击index.html文件,打开流程编辑页面。

      26.png

    导出运行结果

    流程运行完成后,支持导出运行结果到本地。

    1. 单击“导出 > 导出运行结果”。

      27.png

    2. 填写文件名称,选择流程图名称、开始和结束时间后,单击“确定”。

      28.png

    导出代码

    支持导出基于某个流程的Java代码示例。

    1. 单击“导出 > 导出代码”。

      29.png

    推送模板

    用户可将自己设计的流程推送到管理员。管理员将此作为公共模板发布后,其他开发者可共享。

    1. 单击“模板管理 > 推送模板”。

      30.png

    2. 在“模板推送成功”提示页面,单击“确定”。

      31.png

    3. 管理员审核通过后,该流程可在“模板管理 > 模板列表”中查看。