第十五章源代码文件 REST API 简介

程序员 · 2024-9-22 22:04:38

[toc]
第十五章源代码文件 REST API 简介

源代码文件 REST API 简介

此 REST API 提供对源代码文件的访问。我们开辟此 API 是为了答应 Atelier（我们基于 Eclipse 的 IDE）访问 IRIS 服务器上的 IRIS 代码文件。可以利用 API 实行访问 IRIS 代码文件所需的操纵。这些举措包罗：

获取 IRIS 实例上可用的定名空间
查找定名空间中界说的类界说和例程
获取类和例程的文本界说
更新类界说或例程
创建新的类界说或例程
删除类界说或例程
编译 IRIS 类或例程
通过对表实行 SQL 查询来发现 IRIS 环境的属性

这些操纵提供了访问 IRIS 源代码文件的机制。为了创建 IRIS 开辟环境，应该相识此 API 并全面相识 IRIS 源代码文件怎样在 IRIS 中利用。
这是一个特殊用途的 API。如果正在创建开辟环境或处置处罚雷同的应用程序，比方类欣赏器，大概会发现此 API 很有用。但是，它不是用于访问 IRIS 对象的通用 REST API。
本文档形貌了 IRIS 源代码文件 REST API 的版本 1 和 2。 IRIS 的未来版本大概支持此 REST API 的更高版本，提供额外的调用，但将始终可以或许调用早期版本。版本 1 的 API 在 URL 中包罗 /v1/，版本 2的 API 包罗 /v2/。可以通过调用 GetServer 方法找出 IRIS 提供的此 API 的版本。
下面先容 API 的告急功能以及提供这些功能的方法：

获取有关服务器环境的信息：
- GetServer 方法提供有关服务器的告急信息，包罗服务器上的定名空间。
- GetNamespace 方法提供有关指定定名空间的附加信息。它包罗映射到定名空间的数据库列表。
- HeadServer 方法提供有关服务器的标头信息。可以调用 HeadServer 来查抄服务器是否可用。
- GetJobs 方法提供有关在 IRIS 中运行的作业的信息。
- GetCSPApps 方法提供有关服务器界说的 Web 应用程序的信息。这些应用程序提供对 IRIS 的访问。
获取有关源代码文件的信息：
- GetDocNames 方法提供定名空间中源代码文件的名称。您可以选择将文件限定为特定种别的文件或特定文件范例。
- GetModifiedDocNames 方法提供与 GetDocNames 雷同的名称，但别的提供了数据库状态的哈希值。如果生存该文件的当地副本，则可以调用 GetModifiedDocNames 并检察该文档自您前次检索后是否已更改。
- GetDoc 方法获取指定源代码文件的内容。可以选择利用 ETAG 和 If-None-Match 标头来仅获取源代码文件的内容，条件是它自前次检索后发生了更改。
- GetDocs 方法获取指定文件的内容。
- Index 方法提供了定名空间中类界说的一些关键属性。应用程序可以利用此信息来选择要访问的类界说。
- HeadDoc 方法提供有关源代码文件的标头信息。
创建、更新和删除源代码文件
- PutDoc 方法更新现有的源代码文件，大概，如果该文件不存在，则创建一个新的源代码文件。
- DeleteDoc 方法删除指定的源代码文件。
- DeleteDocs 方法删除指定的源代码文件列表。
编译源代码文件
- Compile 方法编译源代码文件。
实行 SQL 查询以从 IRIS 表中获取信息
- Query 方法对任何 IRIS 数据库实行 SQL 查询。
在源代码文件中搜索
- 搜索方法在 IRIS 数据库中搜索源代码文件。
处置处罚 Ensemble 类的特殊要求
- GetEnsClassType 方法返回 Ensemble 对象的类范例。
- GetAdpInputOutputClass 方法返回生产适配器的输入和输出适配器类。

第十五章源代码文件 REST API 简介

所属分类: 问答交流

新帖推荐: 30日

推荐作品

第十五章 源代码文件 REST API 简介

所属分类: 问答交流

新帖推荐: 30日

推荐作品

第十五章源代码文件 REST API 简介