22、API 服务管理：规范、健康监测、错误报告与发现机制

API 服务管理：规范、健康监测、错误报告与发现机制

1. APIs.json 规范与 JSON Home 规范

APIs.json 规范包含 50 多个保留字，其中大部分被称为“属性元素”，用于 APIs.json 文档公共部分条目的类型值。以下是一些示例：
- Signup
- Login
- TermsOfService
- InterfaceLicense
- PrivacyPolicy
- Security
- StatusPage
- Pricing
- Rate Limits

你还可以将自己的名称添加到“属性元素”列表中，作为对该规范的扩展。

另一个可用于携带 API 元数据的规范是 JSON Home 规范。不过，该规范提案已有数年未更新，而且在实际应用中，JSON Home 的使用频率不如这里讨论的 APIs.json 规范。

2. 服务健康监测

在 Web 上使用微服务的一个优势是无需自行编写所有功能，可以借助他人的创意。但添加依赖服务会增加分布式网络中出现故障的可能性。定期对其他服务进行“健康检查”是监测依赖服务状态的有效方法，以确保它们正常运行。

2.1 问题提出

• 如何持续、定期地监测 Web 服务的状态（或健康状况），确保其正常运行并达到预期性能？
• 评估服务健康状况时应监测哪些常见值？
• 传递这些状态值的标准格式是什么？
• 如何宣传对健康监测的支持，以及如何共享状态数据？