介紹
Description
RESTAPI服務器允許模塊通過HTTP公開REST API。
Services Provided
IRestApiService
Service Dependencies依賴的服務
None.
Java File
該模塊在net.flowlightcontroller.restserver.restapiserver中實現。
How it works
RESTAPI服務器使用restlets庫。有關restlet的更多文檔可從這裏獲得。其他將REST服務器作爲依賴項的模塊通過添加實現restletroutable的類來公開API。每個restletroutable都包含一個連接restlet資源的路由器（最常見的是serverresource）。用戶將附加自己的類來擴展restlet資源，以便處理特定URL的請求。在諸如@get、@put等資源註釋中，選擇將用於HTTP請求的方法。序列化是通過包含在restlet庫中的Jackson庫完成的。Jackson可以用兩種方式序列化對象。一種是它將自動在對象上使用可用的getter來序列化這些字段。否則，可以在類的頂部創建和註釋自定義序列化程序。
Limitations
- 基路徑不能重疊，必須是唯一的。
- Restlet只能通過服務接口訪問模塊數據。如果一個模塊需要通過REST服務器公開數據，那麼它必須公開一個接口來獲取該數據。
Configuration
模塊默認啓用，加載模塊不需要更改配置。
