14、Jakarta EE 中的 REST API 开发指南

Jakarta EE 中的 REST API 开发指南

1. 引言

在现代应用开发中，REST 架构已成为不同服务间通信的重要方式。它不仅适用于外部应用与服务的交互，在由多个微服务组成的单一应用中，也能让不同服务高效地进行通信。本文将深入介绍 Jakarta RESTful Web Services 规范，包括如何创建不同类型的 Web 资源，以及如何与其他 Jakarta EE 规范集成，同时还会探讨如何使用 Eclipse MicroProfile REST 客户端以类型安全的方式消费 REST 资源。

2. 建模 REST 服务

REST 网络服务被称为资源，因为它们代表应用程序的资源，且实际代表的资源具有特定领域性。设计 REST 网络服务以向消费客户端公开资源时，需要考虑以下两个关键方面：
- 操作与 HTTP 路径 ：识别可以对资源执行的操作，明确这些操作对应的 HTTP 路径。例如，对于用户资源，可能有创建、更新、查找等操作，每个操作对应不同的 HTTP 路径。
- 数据格式 ：由于 HTTP 语言无关，资源可以以多种格式公开，如 JSON、XML 和纯文本。不过，JSON 已成为 Web 的通用语言，通常是通过 HTTP 公开资源的默认格式。但在向不同客户端公开资源时，资源格式问题仍值得考虑。

以下是用户资源可能的映射关系：
| 操作 | HTTP 路径 | 返回类型 | HTTP 方法 |
| — | — | — | — |
| 创建用户 | /users | 创建的用户 | POST |
| 更新用户 | /use