携手创作，共同成长！这是我参与「掘金日新计划 · 9 月更文挑战」的第7天，点击查看活动详情

第十五章源代码文件 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 方法返回生产适配器的输入和输出适配器类。