1、深 圳 市 C M S 系 統REST服務接口文檔項目代號： CMS-2014-09-15深圳市定制化服務工作室2014-10-02目錄1、 引言 、 REST 介紹 、 編寫目的 3、 編寫原則 、 變更歷史 2、 我的鏈接服務列表 添加標簽分類 4刪除分類標簽 4更新分類標簽 4獲取分類標簽列表 4添加我的鏈接連接 4更新我的鏈接連接 4刪除我的鏈接連接 4查詢我的鏈接連接 41 、 引言1.1 、 REST 介紹REpresentational State Transfer （REST） 是一種架構原則， 其中將 web 服務視為資源， 可以由其 URL 唯一標識。 RESTful We

2、b 服務的關鍵特點是明確使用 HTTP 方法來表示不同的操作的調用。REST 的基本設計原則對典型 CRUD 操作使用 HTTP 協議方法：POST - 創建資源GET - 檢索資源PUT -更新資源DELETE - 刪除資源REST 服務的主要優勢在于：它們是跨平臺 （Java、 PHP 等）高度可重用的，因為它們都依賴基本 HTTP 協議。 它們使用基本的 XML ，而不是復雜的 SOAP XML ，使用非常方便。基于 REST 的 web 服務日益成為后端企業服務集成的首選方法。與基于SOAP 的 web 服務相比，它的編程模型簡單，而本機 XML （而不是 SOAP ）的使用減少了序列

3、化和反序列化過程的復 雜性，并且不再需要其他作用相同的第三方庫。1.2 、 編寫目的 編寫本文的目的是為了將系統功能進行模塊化、服務化，將用戶的操作以服務的方式提供。系統與 系統之間遵循服務規范，將系統與系統之間的交互轉為定制化服務交互，以實現系統與系統之間的 集成。1.3、編寫原則可尋址性(Addressability ) REST中的所有東西都基于資源的概念。資源與 OOP中的對象或其他名詞不 同，它是一種抽象，必須可以通過URI尋址或訪問。接口一致性(In terface un iformity )與SOAP或其他標準不同，REST要求用來操縱資源的方法或動詞不 是任意的。這意味著RES

4、Tful服務的開發人員只能使用 HTTP支持的方法，比如GET、PUT、POST、DELETE 等等。因此不需要使用 WSDL等服務描述語言。無狀態(Statelessness )為了增強可伸縮性，服務器端不存儲客戶機的狀態信息。這使服務器不與特定的客 戶機相綁定，負載平衡變得簡單多了。這還讓服務器更容易監視、更可靠。具象(Representational )客戶機總是與資源的某種具象交互，絕不會直接與資源本身交互。同一資源還可 以有多個具象。理論上說，持有資源的具象的任何客戶機應該有操縱底層資源的足夠信息。連通性(Connectedness )任何基于 REST的系統都應該預見到客戶機需要訪

5、問相關的資源，應該在返回 的資源具象中包含這些資源。例如，可以以超鏈接的形式包含特定RESTful服務的操作序列中的相關步驟，讓客戶機可以根據需要訪問它們。1.4、變更歷史序號變更人員變更時間變更內容1邵震2014-10-02我的鏈接服務、2、公共連接服務列表2.1、添加公共連接分類請求方式PUT服務路徑/common li nk/add/co mmon li nktype路徑參數/描述無參數類型applicati on/json參數描述 nam6:”分類 1”備注：name：分類名稱返回值類型applicati on/json描述添加成功：result:。添加失敗：result:1, ”d

6、”123456”id:分類id不允許重復添加：result:22.2、刪除公共連接分類請求方式DELETE服務路徑/common li nk/delete/type/id路徑參數/描述id :分類id參數類型無參數描述無返回值類型applicati on/json描述添加成功：result:。添加失敗：result:12.3、更新共連接分類請求方式UPDATE服務路徑/common li nk/update/type/id路徑參數/描述id :分類id參數類型applicati on/json參數描述 nam6:”分類 1”備注：name：分類名稱返回值類型applicati on/json描

7、述添加成功：result:。添加失敗：result:12.4、獲取共連接分類列表請求方式GET服務路徑/commo nlin k/list/types路徑參數/描述無參數類型無參數描述無返回值類型applicati on/json描述 “st ”: id ”: ”23456”，”ame”:”xx 官網”userid : 1 ,“ orerid ”: ”1”,id:標簽分類name：標簽分類名稱orderid:標簽分類排序id2.5、添加公共連接請求方式PUT服務路徑/common li nk/add/url路徑參數/描述無參數類型applicati on/json參數描述 n ame : xx

8、x , u rl :, type name : type1 , ” newwin : 1 n ame:公共連接名稱url :公共連接urltype name：公共連接分類名稱newwin :是否在新窗口中打開，0表示否，1表示是返回值類型applicati on/json描述添加成功：result:。添加失敗：result:1不允許往同一類型下添加重復連接：result:22.6、更新公共連接請求方式UPDATE服務路徑/common li nk/update/url路徑參數/描述無參數類型applicati on/json參數描述 name : xxx , u rl :, tag name

9、: t ag1 name我的鏈接連接名稱url:我的鏈接連接urltag name：標簽分類名稱返回值類型applicati on/json描述添加成功：result:。添加失敗：result:12.7、刪除公共連接請求方式DELETE服務路徑/commo nli nk/delete/url/id路徑參數/描述id:公共連接id參數類型applicati on/json參數描述 id”:” 連接 id” id:連接id返回值類型applicati on/json描述刪除成功：result:。刪除失敗：result:12.8、查詢公共連接列表請求方式GET服務路徑/commo nli nk/fin d/urls/tagid路徑參數/描述tagid:標簽分類id參數類型無參數描述無返回值類型app