什么是RESTful
RESTful是一種設(shè)計(jì)原則。只要我們的服務(wù)滿足這種設(shè)計(jì)原則偎行，那我們的服務(wù)便可以稱之為RESTful服務(wù)。
以資源為中心
RESTful api 強(qiáng)調(diào)資源贰拿，api的設(shè)計(jì)應(yīng)該使用名詞性描述而非動(dòng)詞蛤袒，每一個(gè)uri代表一個(gè)資源，用戶通過不同的動(dòng)作（GET, PUT, POST, DELETE）對(duì)資源進(jìn)行操作膨更。 一般來說妙真，GET用于獲取資源，POST用于新建資源荚守，PUT用于更新資源的所有屬性（所以一般我們直接使用POST）珍德，DELETE用于刪除資源。
# RESTful api
# 獲取學(xué)號(hào)為id學(xué)生的信息
GET api/students/id
# 新建一個(gè)學(xué)生資源
POST api/students
args id = XX name = XX ..
# 更新一個(gè)學(xué)生資源
POST api/students/id
args name=XX ..
# 刪除一個(gè)學(xué)生資源
DELETE api/students/id
返回合適的狀態(tài)碼
在HTTP Response中矗漾，響應(yīng)碼是一個(gè)很重要的字段锈候，它反應(yīng)了請(qǐng)求的狀態(tài)。一個(gè)設(shè)計(jì)良好的api應(yīng)該設(shè)計(jì)明確的status code以及錯(cuò)誤提醒信息敞贡”昧眨
一般來說，status code分為2XX嫡锌，3XX虑稼，4XX，5XX這幾種類型势木，2XX 表示請(qǐng)求成功，服務(wù)器完成處理歌懒；3XX表示資源重定向啦桌，請(qǐng)求的資源位置發(fā)生了變化；4XX 發(fā)送的請(qǐng)求錯(cuò)誤；5XX 服務(wù)器端錯(cuò)誤甫男。下面是常見的status code:
200 OK 請(qǐng)求成功接收并處理且改，一般響應(yīng)中都會(huì)有 body
201 Created 請(qǐng)求已完成，并導(dǎo)致了一個(gè)或者多個(gè)資源被創(chuàng)建板驳，最常用在 POST 創(chuàng)建資源的時(shí)候
202 Accepted 請(qǐng)求已經(jīng)接收并開始處理又跛，但是處理還沒有完成。一般用在異步處理的情況若治，響應(yīng) body 中應(yīng)該告訴客戶端去哪里查看任務(wù)的狀態(tài)
204 No Content 請(qǐng)求已經(jīng)處理完成慨蓝，但是沒有信息要返回，經(jīng)常用在 PUT 更新資源的時(shí)候（客戶端提供資源的所有屬性端幼，因此不需要服務(wù)端返回）礼烈。如果有重要的metadata，可以放到頭部返回
301 Moved Permanently 請(qǐng)求的資源已經(jīng)永久性地移動(dòng)到另外一個(gè)地方婆跑，后續(xù)所有的請(qǐng)求都應(yīng)該直接訪問新地址此熬。服務(wù)端會(huì)把新地址寫在 Location 頭部字段，方便客戶端使用滑进。允許客戶端把 POST請(qǐng)求修改為 GET犀忱。
304 Not Modified 請(qǐng)求的資源和之前的版本一樣，沒有發(fā)生改變扶关。用來緩存資源峡碉，和條件性請(qǐng)求（conditional request）一起出現(xiàn)
307 Temporary Redirect 目標(biāo)資源暫時(shí)性地移動(dòng)到新的地址，客戶端需要去新地址進(jìn)行操作驮审，但是不能修改請(qǐng)求的方法鲫寄。
308 Permanent Redirect 和 301 類似，除了客戶端不能修改原請(qǐng)求的方法
400 Bad Request 客戶端發(fā)送的請(qǐng)求有錯(cuò)誤（請(qǐng)求語(yǔ)法錯(cuò)誤疯淫，body 數(shù)據(jù)格式有誤地来，body 缺少必須的字段等），導(dǎo)致服務(wù)端無法處理
401 Unauthorized 請(qǐng)求的資源需要認(rèn)證熙掺，客戶端沒有提供認(rèn)證信息或者認(rèn)證信息不正確
403 Forbidden 服務(wù)器端接收到并理解客戶端的請(qǐng)求未斑，但是客戶端的權(quán)限不足。比如币绩，普通用戶想操作只有管理員才有權(quán)限的資源蜡秽。
404 Not Found 客戶端要訪問的資源不存在，鏈接失效或者客戶端偽造 URL 的時(shí)候回遇到這個(gè)情況
405 Method Not Allowed 服務(wù)端接收到了請(qǐng)求缆镣，而且要訪問的資源也存在芽突，但是不支持對(duì)應(yīng)的方法。服務(wù)端必須返回 Allow 頭部董瞻，告訴客戶端哪些方法是允許的
415 Unsupported Media Type 服務(wù)端不支持客戶端請(qǐng)求的資源格式寞蚌，一般是因?yàn)榭蛻舳嗽?Content-Type 或者 Content-Encoding 中申明了希望的返回格式田巴，但是服務(wù)端沒有實(shí)現(xiàn)。比如挟秤，客戶端希望收到 xml返回壹哺，但是服務(wù)端支持 Json
429 Too Many Requests 客戶端在規(guī)定的時(shí)間里發(fā)送了太多請(qǐng)求，在進(jìn)行限流的時(shí)候會(huì)用到
500 Internal Server Error 服務(wù)器內(nèi)部錯(cuò)誤艘刚，導(dǎo)致無法完成請(qǐng)求的內(nèi)容
503 Service Unavailable 服務(wù)器因?yàn)樨?fù)載過高或者維護(hù)管宵，暫時(shí)無法提供服務(wù)。服務(wù)器端應(yīng)該返回 Retry-After 頭部攀甚，告訴客戶端過一段時(shí)間再來重試
Hypermedia API
Hypermedia：在返回結(jié)果中提供相關(guān)資源的鏈接箩朴。舉個(gè)不是很恰當(dāng)?shù)睦樱€是以學(xué)生為例：
GET api/students/id
# response
{
student_id: XX,
student_class: "api/classses/id",
chinese_score: "api/students/id/chinese",
...
}
類似這種云稚，用戶可以根據(jù)返回的結(jié)果繼續(xù)后面的操作
編寫文檔
對(duì)每個(gè)請(qǐng)求以及返回的參數(shù)進(jìn)行描述隧饼，如果可以給出詳細(xì)而完整的示例。
文章參考：
