01 前言
回歸正題，看過很多RESTful相關的文章總結，參齊不齊，結合工作中的使用，非常有必要歸納一下關於RESTful架構方式了，RESTful只是一種架構方式的約束，給出一種約定的標准，完全嚴格遵守RESTful標准並不是很多，也沒有必要。但是在實際運用中，有RESTful標准可以參考，是十分有必要的。
實際上在工作中對api接口規范、命名規則、返回值、授權驗證等進行一定的約束，一般的項目api只要易測試、足夠安全、風格一致可讀性強、沒有歧義調用方便我覺得已經足夠了，接口是給開發人員看的，也不是給普通用戶去調用。
02 RESTful的來源
REST：Representational State Transfer（表象層狀態轉變），如果沒聽說過REST，你一定以為是rest這個單詞，剛開始我也是這樣認為的，后來發現是這三個單詞的縮寫，即使知道了這三個單詞理解起來仍然非常晦澀難懂。如何理解RESTful架構，最好的辦法就是深刻理解消化Representational State Transfer這三個單詞到底意味着什么。
1.每一個URI代表一種資源；
2.客戶端和服務器之間，傳遞這種資源的某種表現層；
3.客戶端通過四個HTTP動詞（get、post、put、delete），對服務器端資源進行操作，實現”表現層狀態轉化”。
是由美國計算機科學家Roy Fielding（百度百科沒有介紹，真是尷尬了）。Adobe首席科學家、Http協議的首要作者之一、Apache項目聯合創始人。
03 RESTful7大原則
REST之父Roy Fielding在論文中闡述REST架構的7大原則。
1. C-S架構
數據的存儲在Server端，Client端只需使用就行。兩端徹底分離的好處使client端代碼的可移植性變強，Server端的拓展性變強。兩端單獨開發，互不干擾。
2. 無狀態
http請求本身就是無狀態的，基於C-S架構，客戶端的每一次請求帶有充分的信息能夠讓服務端識別。請求所需的一些信息都包含在URL的查詢參數、header、body，服務端能夠根據請求的各種參數，無需保存客戶端的狀態，將響應正確返回給客戶端。無狀態的特征大大提高的服務端的健壯性和可拓展性。
當然這總無狀態性的約束也是有缺點的，客戶端的每一次請求都必須帶上相同重復的信息確定自己的身份和狀態（這也是必須的），造成傳輸數據的冗余性，但這種確定對於性能和使用來說，幾乎是忽略不計的。
3.統一的接口
這個才是REST架構的核心，統一的接口對於RESTful服務非常重要。客戶端只需要關注實現接口就可以，接口的可讀性加強，使用人員方便調用。
4.一致的數據格式
服務端返回的數據格式要么是XML，要么是Json（獲取數據），或者直接返回狀態碼，有興趣的可以看看博客園的開放平台的操作數據的api，post、put、patch都是返回的一個狀態碼 。
自我描述的信息，每項數據應該是可以自我描述的，方便代碼去處理和解析其中的內容。比如通過HTTP返回的數據里面有 [MIME type ]信息，我們從MIME type里面可以知道數據的具體格式，是圖片，視頻還是JSON，客戶端通過body內容、查詢串參數、請求頭和URI（資源名稱）來傳送狀態。服務端通過body內容，響應碼和響應頭傳送狀態給客戶端。這項技術被稱為超媒體（或超文本鏈接）。
除了上述內容外，HATEOS也意味着，必要的時候鏈接也可被包含在返回的body（或頭部）中，以提供URI來檢索對象本身或關聯對象。下文將對此進行更詳細的闡述。
如請求一條微博信息，服務端響應信息應該包含這條微博相關的其他URL，客戶端可以進一步利用這些URL發起請求獲取感興趣的信息，再如分頁可以從第一頁的返回數據中獲取下一頁的URT也是基於這個原理。
5.系統分層
客戶端通常無法表明自己是直接還是間接與端服務器進行連接，分層時同樣要考慮安全策略。
6.可緩存
在萬維網上，客戶端可以緩存頁面的響應內容。因此響應都應隱式或顯式的定義為可緩存的，若不可緩存則要避免客戶端在多次請求后用舊數據或臟數據來響應。管理得當的緩存會部分地或完全地除去客戶端和服務端之間的交互，進一步改善性能和延展性。
7.按需編碼、可定制代碼（可選）
服務端可選擇臨時給客戶端下發一些功能代碼讓客戶端來執行，從而定制和擴展客戶端的某些功能。比如服務端可以返回一些 Javascript 代碼讓客戶端執行，去實現某些特定的功能。
提示：REST架構中的設計准則中，只有按需編碼為可選項。如果某個服務違反了其他任意一項准則，嚴格意思上不能稱之為RESTful風格。
04 RESTful的7個最佳實踐
1. 版本
如github開放平台
https://developer.github.com/v3/
就是將版本放在url，簡潔明了，這個只有用了才知道，一般的項目加版本v1，v2，v3?好吧，這個加版本估計只有大公司大項目才會去使用，說出來不怕尷尬，我真沒用過。有的會將版本號放在header里面，但是不如url直接了當。
https://example.com/api/v1/
2.參數命名規范
query parameter可以采用駝峰命名法，也可以采用下划線命名的方式，推薦采用下划線命名的方式，據說后者比前者的識別度要高，可能是用的人多了吧，因人而異，因團隊規范而異吧。
https://example.com/api/users/today_login 獲取今天登陸的用戶 https://example.com/api/users/today_login&sort=login_desc 獲取今天登陸的用戶、登陸時間降序排列
3.url命名規范
API 命名應該采用約定俗成的方式，保持簡潔明了。在RESTful架構中，每個url代表一種資源所以url中不能有動詞，只能有名詞，並且名詞中也應該使用復數。實現者應使用相應的Http動詞GET、POST、PUT、PATCH、DELETE、HEAD來操作這些資源即可
不規范的的url，冗余沒有意義，形式不固定，不同的開發者還需要了解文檔才能調用。
https://example.com/api/getallUsers GET 獲取所有用戶 https://example.com/api/getuser/1 GET 獲取標識為1用戶信息 https://example.com/api/user/delete/1 GET/POST 刪除標識為1用戶信息 https://example.com/api/updateUser/1 POST 更新標識為1用戶信息 https://example.com/api/User/add POST 添加新的用戶
規范后的RESTful風格的url，形式固定，可讀性強，根據users名詞和http動詞就可以操作這些資源
https://example.com/api/users GET 獲取所有用戶信息 https://example.com/api/users/1 GET 獲取標識為1用戶信息 https://example.com/api/users/1 DELETE 刪除標識為1用戶信息 https://example.com/api/users/1 Patch 更新標識為1用戶部分信息,包含在body中 https://example.com/api/users POST 添加新的用戶
4. 統一返回數據格式
對於合法的請求應該統一返回數據格式，這里演示的是json
code——包含一個整數類型的HTTP響應狀態碼。
status——包含文本：”success”，”fail”或”error”。HTTP狀態響應碼在500-599之間為”fail”，在400-499之間為”error”，其它均為”success”（例如：響應狀態碼為1XX、2XX和3XX）。這個根據實際情況其實是可要可不要的。
message——當狀態值為”fail”和”error”時有效，用於顯示錯誤信息。參照國際化（il8n）標准，它可以包含信息號或者編碼，可以只包含其中一個，或者同時包含並用分隔符隔開。
data——包含響應的body。當狀態值為”fail”或”error”時，data僅包含錯誤原因或異常名稱、或者null也是可以的
返回成功的響應json格式
{ "code": 200, "message": "success", "data": { "userName": "123456", "age": 16, "address": "beijing" } }
返回失敗的響應json格式
{ "code": 401, "message": "error message", "data": null }
下面這個ApiResult的泛型類是在項目中用到的，拓展性強，使用方便。返回值使用統一的 ApiResult 或 ApiResult
錯誤返回 使用 ApiResult.Error 進行返回； 成功返回，要求使用 ApiResult.Ok 進行返回
public class ApiResult: ApiResult { public new static ApiResult<T> Error(string message) { return new ApiResult<T> { Code = 1, Message = message, }; } [JsonProperty("data")] public T Data { get; set; } } public class ApiResult { public static ApiResult Error(string message) { return new ApiResult { Code = 1, Message = message, }; } public static ApiResult<T> Ok<T>(T data) { return new ApiResult<T>() { Code = 0, Message = "", Data = data }; } /// <summary> /// 0 是 正常 1 是有錯誤 /// </summary> [JsonProperty("code")] public int Code { get; set; } [JsonProperty("msg")] public string Message { get; set; } [JsonIgnore] public bool IsSuccess => Code == 0; }
5. http狀態碼
在之前開發的xamarin android博客園客戶端的時候，patch、delete、post操作時body響應里面沒有任何信息，僅僅只有http status code。HTTP狀態碼本身就有足夠的含義，根據http status code就可以知道刪除、添加、修改等是否成功。(ps:有點linux設計的味道哦，沒有返回消息就是最好的消息，表示已經成功了)服務段向用戶返回這些狀態碼並不是一個強制性的約束。簡單點說你可以指定這些狀態，但是不是強制的。常用HTTP狀態碼對照表
HTTP狀態碼也是有規律的
1**請求未成功
2**請求成功、表示成功處理了請求的狀態代碼。
3**請求被重定向、表示要完成請求，需要進一步操作。 通常，這些狀態代碼用來重定向。
4** 請求錯誤這些狀態代碼表示請求可能出錯，妨礙了服務器的處理。
5**（服務器錯誤）這些狀態代碼表示服務器在嘗試處理請求時發生內部錯誤。 這些錯誤可能是服務器本身的錯誤，而不是請求出錯。
6. 合理使用query parameter
在請求數據時，客戶端經常會對數據進行過濾和分頁等要求，而這些參數推薦采用HTTP Query Parameter的方式實現
//比如設計一個最近登陸的所有用戶 https://example.com/api/users?recently_login_day=3 //搜索用戶，並按照注冊時間降序 https://example.com/api/users?recently_login_day=3 //搜索用戶，並按照注冊時間升序、活躍度降序 https://example.com/api/users?q=key&sort=create_title_asc,liveness_desc //關於分頁，看看博客園開放平台分頁獲取精華區博文列表 https://api.cnblogs.com/api/blogposts/@picked?pageIndex={pageIndex}&pageSize={pageSize} 返回示例： [ { “Id”: 1, “Title”: “sample string 2”, “Url”: “sample string 3”, “Description”: “sample string 4”, “Author”: “sample string 5”, “BlogApp”: “sample string 6”, “Avatar”: “sample string 7”, “PostDate”: “2017-06-25T20:13:38.892135+08:00”, “ViewCount”: 9, “CommentCount”: 10, “DiggCount”: 11 }, { “Id”: 1, “Title”: “sample string 2”, “Url”: “sample string 3”, “Description”: “sample string 4”, “Author”: “sample string 5”, “BlogApp”: “sample string 6”, “Avatar”: “sample string 7”, “PostDate”: “2017-06-25T20:13:38.892135+08:00”, “ViewCount”: 9, “CommentCount”: 10, “DiggCount”: 11 } ]
7. 多表、多參數連接查詢如何設計URL
這是一個比較頭痛的問題，在做單個實體的查詢比較容易和規范操作，但是在實際的API並不是這么簡單而已，這其中常常會設計到多表連接、多條件篩選、排序等。
比如我想查詢一個獲取在6月份的訂單中大於500元的且用戶地址是北京，用戶年齡在22歲到40歲、購買金額降序排列的訂單列表
https://example.com/api/orders?order_month=6&order_amount_greater=500&address_city=北京&sort=order_amount_desc&age_min=22&age_max=40
從這個URL上看，參數眾多、調用起來還得一個一個仔細對着，而且API本身非常不容易維護，命名看起來不是很容易，不能太長，也不能太隨意。
在.net WebAPI總我們可以使用屬性路由，屬性路由就是講路由附加到特定的控制器或操作方法上裝飾Controll及其使用[Route]屬性定義路由的方法稱為屬性路由。
這種好處就是可以精准地控制URL，而不是基於約定的路由，簡直就是為這種多表查詢量身定制似的的。 從webapi 2開發，現在是RESTful API開發中最推薦的路由類型。
我們可以在Controll中標記Route
[Route(“api/orders/{address}/{month}”)]
Action中的查詢參數就只有金額、排序、年齡。減少了查詢參數、API的可讀性和可維護行增強了。
https://example.com/api/orders/beijing/6?order_amount_greater=500&sort=order_amount_desc&age_min=22&age_max=40
這種屬性路由比如在博客園開放的API也有這方面的應用，如獲取個人博客隨筆列表
//請求方式：GET 請求地址：https://api.cnblogs.com/api/blogs/{blogApp}/posts?pageIndex={pageIndex} (ps:blogApp：博客名)