REST服務接口文檔

1、LOGOREST服務接口文檔集團標準化小組：VVOPPT-JOPP28-JPPTL98-LOPPNN深 圳 市CMSREST月艮務接文檔項目代號：CMS-2014-09-15深圳市定制化服務工作室2014-10-02目錄1.1、REST 介紹1. 1、編寫 目 的31、 2 編寫原則1.3、 變更歷史2、 我的鏈接服務列表2.3、 添加標簽分類 42.4、 刪除分類標簽42.5、 更新分類標簽42.6、 獲取分類標簽列表42.7、 添加我的鏈接連接42.8、 更新我的鏈接連接42.9、 刪除我的鏈接連接42.10、 查詢我的鏈接連接41、引言1.1、 REST 介紹REpresentation

2、alStateTransfer （REST）是一種架構原則，其中將web服務視為資源，可以由 其URL唯一標識。RESTfulWeb服務的關鍵特點是明確使用HTTP方法來表示不同的操作的調(diào) 用。REST的基本設計原則對典型CRUD操作使用HTTP協(xié)議方法：POST-創(chuàng)建資源GET-檢索資源PUT-更新資源DELETE-刪除資源REST服務的主要優(yōu)勢在于：它們是跨平臺（Java、.net、PHP等）高度可重用的,因為它們都依賴基本HTTP協(xié)議。它們使用基本的XML,而不是復雜的S0APXML,使用非常方便?；赗EST的web服務日益成為后端企業(yè)服務集成的首選方法。與基于SOAP的web服務相

3、比，它的編程模型簡單，而本機XML （而不是SOAP）的使用減少了序列化和反序列化過程的 復雜性，并且不再需要其他作用相同的第三方庫。L2、 編寫目的編寫本文的目的是為了將系統(tǒng)功能進行模塊化、服務化，將用戶的操作以服務的方式提供。 系統(tǒng)與系統(tǒng)之間遵循服務規(guī)范，將系統(tǒng)與系統(tǒng)之間的交互轉(zhuǎn)為定制化服務交互，以實現(xiàn)系統(tǒng) 與系統(tǒng)之間的集成。1. 3、 編寫原則可尋址性(Addressability) REST中的所有東西都基于芬源的概念。資源與OOP中的對象或其他名詞不同，它是一種抽 象，必須可以通過URI尋址或訪問。接口一致性(Interfaceuniformity)與SOAP或其他標準不同，REST

4、要求用來操縱資源的方法或動詞不是任意的。這意味 著RESTful服務的開發(fā)人員只能使用HTTP支持的方法，比如GET、PUT、POST、DELETE等等。因此不需要使用WSDL等服務 描述語者。無狀態(tài)(Statelessness)為了增強可伸縮性，服務器端不存儲客戶機的狀態(tài)信息。這使服務器不與特定的客戶機相綁定， 負載平衡變得簡單多了。這還讓服務器更容易監(jiān)視、更可旎。具象(Representational)客戶機總是與資源的某種具象交互，絕不會直接與資源本身交互。同一資源還可以有多個具 象。理論上說，持有資源的具象的任何客戶機應該有操縱底層資源的足夠信息。連通性(Connectedness)任

5、何基于 REST的系統(tǒng)都應該預見到客戶機需要訪問相關的資源，應該在返回的資源具象中包含 這些資源。例如，可以以超鏈接的形式包含特定RESTful服務的操作序列中的相關步驟，讓客戶機可以根據(jù)需要訪問它 們。2. 4、變更歷史序號變更人員變更時間變更內(nèi)容1邵震2014-10-02我的鏈接服務 2.1、2.2、2.3、2.4. 2.5. 2.6、2.7. 2.82、公共連接服務列表3. 1、添加公共連接分類請求方式PUT服務路徑/commonlink/add/common1inktype路徑參數(shù)/描述無參數(shù)類型application/json參數(shù)描述 “name" ：“ 分類 1"

6、; 備注：name：分類名稱返回值類型application/json描述添加成功：result: 0添加失敗:result: 1, “ id" ： “123456” id：分類id不允許重復添加：results)4. 2、刪除公共連接分類請求方式DELETE服務路徑/commonlink/delete/type/id路徑參數(shù)/描述id：分類id參數(shù)類型無參數(shù)描述無返回值類型application/json描述添加成功：result :0添加失敗：result：15. 3、更新共連接分類請求方式UPDATE服務路徑/commonlink/update/type/id路徑參數(shù)/描述id

7、：分類id參數(shù)類型application/json參數(shù)描述 “name" ：" 分類 1” 備注：name：分類名稱返回值類型application/json描述添加成功：result :0添加失敗：result：16. 4、獲取共連接分類列表請求方式GET服務路徑/commonlink/list/types路徑參數(shù)/描述無參數(shù)類型無參數(shù)描述無返回值類型application/json描述 “l(fā)ist” ： “id” ：” 123456”，“ name" ：" xxx 官網(wǎng)”，"userid“ ： “ 1“，u order id n :&quo

8、t; 1" ，,id：標簽分類name：標簽分類名稱orderid：標簽分類排序id2. 5、添加公共連接請求 方式PUT服務/commonlink/add/url路徑路徑無參數(shù)/描述參數(shù)application/json類型參數(shù)t name ： xxx , url ： xxx. com , typename ： type! , newwm ： 1 )描述name ：公共連接名稱url：公共連接urltypename：公共連接分類名稱newin：是否在新窗口中打開，0表示否，1表示是返回application/json值類型描述添加成功：result :0添加失?。簉esult :1)

9、不允許往同一類型下添加重復連接：result:22. 6、更新公共連接請求方式UPDATE服務路徑/commonlink/update/url路徑參數(shù)/描述無參數(shù)類型application/json參數(shù)描述t name : xxx , url : xxx. com , tagname : tagl /name：我的鏈接連接名稱url：我的鏈接連接urltagname：標簽分類名稱返回值類型application/json描述添加成功：result: 0添加失?。簉esult：12.7、刪除公共連接2.8、查詢公共連接列表請求方式DELETE服務路徑/commonlink/delete/url/id路徑參數(shù)/描述id:公共連接id參數(shù)類型application/json參數(shù)描述 “id" ：" 連接 id” id:連接id返回值類型application/json描述刪除成功：result ：0刪除失?。簉esult：1請求方式GET服務路徑/commonlink/find/urIs/tagid)路徑參數(shù)/描述tagid：標簽分類id參數(shù)類型無參數(shù)描述無返回值類型application/json描述 “commonlinklist" ： "id"