Liberty 內顯露 REST 端點

您可以在 Liberty SPI 中使用 REST Handler 架構,來顯露新的 REST 端點。

關於這項作業

REST Handler 架構是供 Liberty 延伸器在顯露新的 REST 端點時使用。您可以在 OSGi 元件或一組元件中顯露 REST 端點。

程序

  1. 建立 OSGi 元件,將它本身登錄成接聽一個附加到 /ibm/api 的子根目錄,並實作 com.ibm.wsspi.rest.handler.RESTHandler 介面;例如:
    @Component(service = { RESTHandler.class },
               configurationPolicy = ConfigurationPolicy.IGNORE,
               immediate = true,
               property = { "service.vendor=IBM",
                            RESTHandler.PROPERTY_REST_HANDLER_ROOT + "=/myTest/abc" })
    public class RESTHANDLERTest1 implements RESTHandler {
    ...
  2. 將元件包裝成 OSGi 軟體組,且該 OSGi 軟體組是您所延伸之使用者特性的一部分。
  3. 確定您的特性包含 OSGi 子系統內容:
    com.ibm.websphere.appserver.restHandler-1.0; type="osgi.subsystem.feature"
  4. server.xml 檔中,配置 SSL 憑證
  5. server.xml 檔中,將使用者或群組配置為管理者角色。
    註: 在您的 REST 處理程式定義中,如果 OSGi 內容 com.ibm.wsspi.rest.handler.RESTHandler.PROPERTY_REST_HANDLER_CUSTOM_SECURITY 設為 true,則非管理者身分的使用者可以存取您的 REST 端點。
  6. 啟動您的特性。

    啟動特性時,會啟動 REST Handler 架構,並登錄您的 OSGi 元件。在特性啟動之後,可以呼叫 https://<host>:<https_port>/ibm/api/myTest/abc


指示主題類型的圖示 作業主題

檔名:twlp_expose_rest_endpoints.html