简体中文
English 简体中文 繁體中文
Methodox 首页

创建 Web API 服务器

难度: ★★☆☆☆(中级) 收获: ★★☆☆☆(中等) 上下文: 数据流上下文 阅读时间: 5 分钟

Web API 服务器让我们能够通过 HTTP 协议在互联网上公开服务。

概述

一旦理解了相关概念,制作 Web API 服务器就相当容易。如果需要复习,请查阅知识库中关于该主题的内容。

我们可以利用 Ol'ista 的 Web API 功能,在数据流上下文中以图形方式开发简单的 Web API 服务器:

图:提供 Web API 服务
图:提供 Web API 服务

服务器端

在服务器端,只需使用 Web API Capability,配合图引用(或嵌入的子图)来定义端点行为:

  1. 使用 Reference 节点引用图;
  2. 使用 Create Web API Capability 创建 API 端点。
  3. 使用 Serve 节点启动服务器。
图:服务器端的 Web API Capability
图:服务器端的 Web API Capability

客户端

在客户端,我们可以使用 Send Request 并指定相应的方法类型。

  1. 使用 Send Request 并指定相应的方法类型来发送请求;确保 URL 与端点 URL 一致。
  2. 对于 GET,通常不需要请求体。
  3. 使用 Preview 节点在画布上查看结果。
图:客户端
图:客户端

完整设置

对于被引用的图:

  1. 使用 Inputs 节点定义两个输入:String Map 和 String;
  2. 使用 Outputs 节点输出单个 EndpointResponse;
  3. 使用 Make Endpoint Response 将字符串值转换为 EndpointResponse 对象。

下面展示了完整的设置。上方的两个窗口是作为处理程序被引用的子图。

图:设置
图:设置

通过 Serve 运行服务器后,我们可以在客户端(右下方)查看 Send Request 的结果。

图:执行
图:执行

参考资料