RESTful 应用程序编程接口 (API) 设计和文档编制初学者指南。 通过示例，您将学习一些常见的 RESTful API 模式。

在阅读之前

您需要知道

• 如何在 Ensemble 中创建 RESTful Web 服务
• 如何在 Ensemble 中使用 RESTful Web 服务
• 如何传递服务参数
• 如何返回服务结果

什么是服务 API？

什么是应用程序编程接口？ 是具体化的东西吗？ 是单一编程单元吗？ API 的作用是什么？ 在我看来，API 是由程序代码以间接方式决定的。 但完全定义的 API 是由运行可执行程序的容器（由部署设置控制）提供的。 因此，我宁愿将 API 定义为服务的公共描述。 该描述可以是人类可读的，也可以仅机器可读， 或者两者均可。 API 用于与将要使用服务的人员共享有关服务的基本信息。 API 说明了服务的作用、使用环境、功能以及管理的数据结构等。

HealthConnect中创建HTTP服务端

这里我说说怎么在HealthConnect上开发HTTP服务。

作为消息引擎，HealthConnect会需要从一个接口接收HTTP请求发送到另一个接口，中间做消息转换，路由等等，目的的接口可能是HTTP，或者SOAP，REST等等。这里只介绍HTTP服务的内容，也就是最简单的两种实现：

第一种：实现客户定制的HTTP服务业务服务组件(Business Servie)

创建Business Service类，继承EnsLib.HTTP.Service， 如下面的示例:

#Open Exchange

您可能已经看到邀请分享您的 Open Exchange 应用程序的演示：Share a Demo of Your Open Exchange Application

它背后的服务——InterSystems Online Demo Server (ODS)——这不是什么新事物

第六章 Caché JSON 使用JSON适配器

JSON适配器是一种将ObjectScript对象(registered, serial or persistent)映射到JSON文本或动态实体的方法。本章涵盖以下主题：

InterSystems Production 监控是管理门户中的一个页面，用于显示当前运行的Production监控信息。我喜欢这个页面的样子，但这并不适合所有人。

2022年5月13日，我在开发者社区上看到这个帖子。

https://community.intersystems.com/post/creating-custom-monitoring-page

我同意马克的观点，Production监控很复杂。我想创建一个更漂亮干净的监控页面。

我开始着手制作一个利用类方法提供Production数据的 CSP（Cache Server Page）页面。

我与马克分享了我的第一次尝试。他根据自己的想法定制了这个页面。我喜欢他对页面的布局，使其在视觉上更有吸引力。我把他的设计整合到我的应用程序Production监控中。

我看到马克对业务服务的显示进行了过滤，只显示需要注意的服务。他在页面的底部添加了服务器的名称和它的镜像状态。

动机

这个项目是在我考虑如何通过Embedded Python让Python代码自然地处理IRIS globals所提供的可扩展的存储和高效的检索机制时想到的。

我最初的想法是使用globals创建一种Python字典的实现，但很快我就意识到，我应该首先处理对象的抽象问题。

所以，我开始创建一些可以包装Python对象的Python类，在globals中存储和检索它们的数据，也就是说，在IRIS globals中序列化和反序列化Python对象。

[toc]

第二十八章 定制SAX解析器创建自定义内容处理程序

创建自定义内容处理程序

如果直接调用InterSystems IRIS SAX解析器，则可以根据自己的需要创建自定义内容处理程序。本节讨论以下主题：
- Overview
- 要在内容处理程序中自定义的方法的描述
- %XML.SAX.Parser类中解析方法的参数列表摘要
- 示例

创建自定义内容处理程序概述

要定制InterSystems IRIS SAX解析器导入和处理XML的方式，请创建并使用定制的SAX内容处理程序。具体地说，创建%XML.SAX.ContentHandler的子类。然后，在新类中，重写任何默认方法以执行所需的操作。在解析XML文档时使用新的内容处理程序作为参数；为此，需要使用%XML.SAX.Parser类的解析方法。

此操作如下图所示：

IRIS Interoperability互操作性/HealthConnect（前身是Ensemble）有许多内置的适配器。但是没有一个接收邮件的服务或适配器。我洗的了一个电子邮件服务，通过SMTP接收邮件，这些邮件可以被传递到电子邮件操作。

现在我想对一个使用电子邮件操作向外部邮件服务器发送邮件的Production进行负载测试。邮件服务器团队不希望我向他们发送成千上万的信息。

我创建了iris-mail应用程序来替代邮件服务器。我更新了电子邮件操作中的服务器和端口设置。外发的邮件被发送到替代的邮件服务器，我能够计算出iris-mail中收到的邮件数量，并将其与邮件操作发送的邮件数量进行比较。

应用程序的源代码：https://openexchange.intersystems.com/package/iris-mail

第十七章 类关键字 - DependsOn

指定此类应在编译器使其他(指定的)类可运行后编译。

用法

要指示类编译器应该在其他类可运行后编译此类，请使用以下语法:

Class MyApp.MyClass [ DependsOn = classlist ]  
{ //class members }

其中classlist是下列之一:

• 类名

[ DependsOn = MyApp.Class1 ]

• 用逗号分隔的类名列表，用括号括起来。

[ DependsOn = (MyApp.Class1,MyApp.Class2,...) ]

详情

此关键字指定类编译器应该在使指定的类可运行后编译此类。

如果此类的编译使用方法生成器逻辑中的这些其他类，则此关键字非常有用。如果类包含调用其他类的初始表达式，这也很有用。

InterSystems 常见问题解答

如果系统24小时没有停止，旧的日志文件将根据“日志文件删除设置”在0:30删除。

导致日志文件保留的时间早于“日志文件删除设置”的一个可能原因是存在仍处于开放状态的事务。

在这种情况下，您将能够通过搜索执行事务的进程并完成事务来删除日志文件。

下面的示例检查是否存在未完成的事务，如果存在，则输出目标文件名和日志记录信息。

（示例可以从这里下载

*注意*如果要检查的日志文件较大或日志文件较多，则执行需要时间，因此请联系我们的支持中心。

在检查我们的^pButtons（在IRIS中改名为^SystemPerformance）性能监控工具的文档时，一位客户告诉我。"我理解所有内容，但我希望它能更简单......更容易定义配置文件，管理它们等等"。

在这次会议之后，我认为尝试为其提供一些更简单的人机界面是一个不错的试验。

这方面的第一步是在现有的pButtons例程上包裹一个基于类的API。

我还能够添加一些更多的 "功能"，比如显示当前正在运行的配置文件，它们剩余的运行时间，以前运行的进程等等。

下一步是在这个API的基础上添加一个REST API类。

有了这个工件（pButtons REST API），人们就可以在上面建立一个比较时髦的用户界面。

举个🌰： -

大家好！

如您所知，我们发布了 InterSystems Open Exchange — 面向 InterSystems 数据平台上的解决方案和工具的市场！

但是如何在 OE 上发布应用程序？

在开始前，我先回答几个基本问题。