文章
姚 鑫 · 七月 21 阅读大约需 3 分钟

第三章 使用 ^%REST 例程创建 REST 服务

第三章 使用 ^%REST 例程创建 REST 服务

本章介绍如何使用 ^%REST 例程创建和删除 REST 服务。

提示:还可以使用此例程更新REST服务;只需删除REST服务,然后重新创建它。

使用^%REST例程

^%REST例程是一个简单的命令行界面。在任何提示下,可以输入以下答案:

  • ^ - 使例程跳回上一个问题。
  • ? - 使例程显示一条列出所有当前选项的消息。
  • qquit - 结束例程。

此外,每个问题都会在括号中显示该问题的默认答案。

使用^%REST例程创建REST服务

创建REST服务的推荐方法是从REST服务的OpenAPI2.0规范开始,并使用该规范生成REST服务类。要使用^%REST例程执行此操作:

  1. 获取JSON格式的REST服务的OpenAPI 2.0规范。将规范另存为文件或记下可访问规范的URL。
  2. 在终端中,更改到要在其中定义REST服务的名称空间。
  3. 输入以下命令以启动^%REST例程:
do ^%REST
  1. 在第一个提示符处,输入 REST 服务的名称。该名称用作生成类的包名;使用有效的包名。如果想使用名称列表、lquitq(在任何情况下都是变体),请将名称用双引号括起来。例如:"list"
  2. 在下一个提示符处,输入 Y(不区分大小写)以确认您要创建此服务。

然后,该例程会提示输入要使用的 OpenAPI 2.0 规范的位置。输入完整路径名或 URL

  1. 在下一个提示符处,输入 Y(不区分大小写)以确认要使用此规范。

该例程在此命名空间中的指定包内创建dispimplspec 类。然后该例程显示如下输出:

-----Creating REST application: myapp-----
CREATE myapp.spec
GENERATE myapp.disp
CREATE myapp.impl
REST application successfully created.

接下来,例程会询问否还想创建一个 Web 应用程序。将使用此 Web 应用程序来访问 REST 服务。

  1. 此时,可以执行以下操作:

- 输入 Y(不区分大小写)立即创建 Web 应用程序。
- 输入 N(不区分大小写)结束例程。

  1. 如果输入了 Y,则例程会提示您输入 Web 应用程序的名称。

该名称在这个 IRIS 实例中必须是唯一的。默认名称基于运行 Web 应用程序的命名空间:/csp/namespace

输入 Web 应用程序的名称或按回车键接受默认名称。

然后该例程显示如下输出:

-----Deploying REST application: myapp-----
Application myapp deployed to /csp/myapp
  1. 按照“修改实现类”一章中的描述定义实现。

使用 ^%REST 例程删除 REST 服务

要使用 ^%REST 例程删除 REST 服务:

  1. 在终端中,更改为可以找到 REST 服务的命名空间。
  2. 输入以下命令以启动 ^%REST 例程:
do ^%REST
  1. 在第一个提示符处,输入 REST 服务的名称。

如果不确定 REST 服务的名称,请输入 L(不区分大小写)。该例程列出所有 REST 服务,然后再次提示您输入 REST 服务的名称。

  1. 如果例程找到具有给定名称的 REST 服务,则会显示如下提示:
REST application found: petstore
Do you want to delete the application? Y or N (N):
  1. 输入 Y(不区分大小写)以确认要删除此服务。
  2. (可选)手动删除实现类。

为安全起见,例程不会自动删除实现类,因为该类可能包含大量定制。

0
0 13
讨论 (0)1
登录或注册以继续