Samza REST服務(wù)資源

Samza REST可以暴露任何 JAX-RS 資源。默認(rèn)情況下，它附帶了一個(gè) JobsResource，這將在下面討論。您可以實(shí)現(xiàn)自己的資源并在配置中指定它們。

實(shí)施新資源

Samza REST使用 Jersey 實(shí)現(xiàn)的 JAX-RS規(guī)范。Jersey 文檔和示例有助于創(chuàng)建新的資源。

此外，Samza REST強(qiáng)加了以下約定，所有資源都應(yīng)遵循這些約定。

版本路徑

按照慣例，所有資源都使用版本號(hào)在其路徑前面，以便將來(lái)支持舊版API。例如，JobsResource 的基本URL是：

/v1/jobs

如果將來(lái)版本的 JobsResource 實(shí)現(xiàn)了不同的 API，那么它將在基本路徑中使用不同的版本號(hào)：

/v2/jobs

所有資源都應(yīng)該在最新版本上公開，以便客戶端可以為所有請(qǐng)求使用通用版本庫(kù)。

錯(cuò)誤消息

每個(gè)錯(cuò)誤響應(yīng)將包含一個(gè) JSON 消息正文，其中包含描述問(wèn)題的單個(gè)消息字段。例如：

{
    "message": "Unrecognized status: null"
}

組態(tài)

對(duì)于需要配置值的資源，還有一些額外的步驟。

1. 實(shí)現(xiàn)一個(gè)配置類，它將 MapConfig 擴(kuò)展為 Resource 的配置的所有常量和訪問(wèn)器。該 SamzaRestConfig 不應(yīng)與資源 CONFIGS 弄得一團(tuán)糟。請(qǐng)參閱 JobsResourceConfig 作為示例。
2. 實(shí)現(xiàn)或擴(kuò)展 ResourceFactory，它將使用全局 Samza REST 配置文件從第1步中實(shí)例化 MapConfig 實(shí)現(xiàn)，并使用它來(lái)構(gòu)建需要配置的資源。有關(guān)示例，請(qǐng)參閱 DefaultResourceFactory。
3. 將所有必需的資源屬性添加到 Samza REST配置文件。該 SamzaRestApplication 通過(guò)全局配置到配置 ResourceFactories 的資源與 CONFIGS 實(shí)例。

向 Samza REST服務(wù)添加新資源

資源通過(guò)配置添加到 Samza REST服務(wù)。根據(jù)資源是否需要配置文件的屬性，有兩種添加新資源的方法。在前一種情況下，資源使用 config 實(shí)例化一次，并且實(shí)例已注冊(cè)到SamzaRestApplication；在后一種情況下，Resource 類被注冊(cè)，并且可以在應(yīng)用程序的生命周期內(nèi)實(shí)例化多次。

• 要添加配置的資源，請(qǐng)將 ResourceFactory 實(shí)現(xiàn)的完全限定類名稱實(shí)例化為 rest.resource.factory.classes 服務(wù)配置中的屬性。
• 要添加無(wú)配置資源，請(qǐng)將資源實(shí)現(xiàn)的完全限定類名添加到 rest.resource.classes 服務(wù)配置中的屬性中。

有關(guān)這些配置屬性的更多信息，請(qǐng)參閱概述頁(yè)面中的配置表。

REST服務(wù)監(jiān)視器    ?