本章介绍如何使用 /api/mgmnt
服务来创建、更新和删除 REST
服务。
/api/mgmnt
服务还提供了可用于发现和记录 Web
服务的选项,如本书后面所述。
创建 REST
服务的推荐方法是为 REST
服务创建 OpenAPI 2.0
(也称为 Swagger
)描述,并使用它来生成 REST
服务类。如果您正在实现由第三方定义的 REST
服务,他们可能会提供此 OpenAPI 2.0
描述。有关 OpenAPI 2.0
描述格式的详细信息,请参阅 OpenAPI 2.0
规范。以下主题描述了如何使用 /api/mgmnt
服务来执行此操作。
第一步,生成 REST
服务类,如下所示:
JSON
格式创建或获取 REST
服务的 OpenAPI 2.0
描述。REST
测试工具,例如 PostMan
(https://www.getpostman.com/)。HTTP
请求消息:HTTP
操作,选择或指定 POST
。URL
,请指定以下形式的 URL
:http://localhost:52773/api/mgmnt/v2/namespace/myapp
其中 localhost
是服务器的名称,52773
是运行 IRIS
的 Web
服务器端口,namespace
是要在其中创建 REST
服务的名称空间,myapp
是要在其中创建类的包的名称.
JSON
格式粘贴Web
服务的 OpenAPI 2.0
描述。JSON
(application/json
)IRISUsername
和 IRISPassword
参数提供值。对于 IRISUsername
,指定一个用户,该用户是 %Developer
角色的成员,并且对给定的命名空间具有读/写访问权限。如果调用成功, IRIS
在给定的包和命名空间中创建 disp
、impl
和 spec
类。
{
"msg": "New application myapp created"
}
要完成基本的 REST
服务,请创建一个 Web
应用程序并定义实现。可以按任意顺序执行这些步骤。
在此步骤中,将创建一个提供对 REST
服务的访问权限的 Web
应用程序。在管理门户中,完成以下步骤:
System Administration > Security > Applications > Web Applications
.Web
应用程序。Name
— Web
应用程序的名称;这在这个 IRIS
实例中必须是唯一的。最常见的名称基于运行 Web
应用程序的命名空间:/csp/namespace
Namespace
- 选择在其中生成类的命名空间。Enable Application
— 选中此复选框。Enable
— 选择 REST
。Dispatch Class
— 键入调度类的完全限定名称。这应该始终是 package.disp
,其中 package
是包含生成的类的包的名称。API
管理工具使能够更新生成的类,而无需更改在实现类中所做的编辑。如有必要,将重新生成该类,但保留编辑。
要更新 REST
服务,请使用“使用 /api/mgmnt
服务生成类”中列出的步骤。
如果更新成功,IRIS
会重新生成给定包中的 disp
和 spec
类并更新 impl
类,保留对该类所做的编辑。响应消息将类似于以下示例:
{
"msg": "Application myapp updated"
}
如果之前编辑过 impl
类, 会保留这些编辑,如下所示:
但是,会重新生成类和每个生成方法的描述(///
注释)。如果任何实现方法的签名发生更改(例如,因为规范已更改),会更新签名并将以下注释添加到该类方法:
/// WARNING: This method's signature has changed.
API
管理工具还使能够轻松删除 REST
服务。为此:
REST
测试工具,创建 HTTP
请求消息,如下所示:HTTP
操作,选择或指定 DELETE
。URL
,请指定以下形式的 URL
:http://localhost:52773/api/mgmnt/v2/namespace/myapp
其中 localhost
是服务器的名称,52773
是运行 IRIS
的 Web
服务器端口,namespace
是要创建 REST
服务的名称空间,myapp
是包含 REST
服务类的包的名称。
IRISUsername
和 IRISPassword
参数提供值。对于 IRISUsername
,指定一个用户,该用户是 %Developer
角色的成员,并且对给定的命名空间具有读/写访问权限。如果调用成功,IRIS
将删除给定包和命名空间中的 disp
和 spec
类。
但是, IRIS
不会删除 impl
类。
{
"msg": "Application myapp deleted"
}
为安全起见,/api/mgmnt
服务不会自动删除实现类,因为该类可能包含大量自定义。
REST
服务创建的 Web
应用程序(如果有)。为此:a. 在管理门户中,单击System Administration > Security > Applications > Web Applications
。
b. 在列出 Web
应用程序的行中单击删除。
c. 单击确定以确认删除。
本文系转载,前往查看
如有侵权,请联系 cloudcommunity@tencent.com 删除。
本文系转载,前往查看
如有侵权,请联系 cloudcommunity@tencent.com 删除。