REST服務和HTTP Headers

REST服務

REST service是一種架構模式，RESTFul架構應該遵循統一接口原則，統一接口包含了一組受限的預定義的操作，不論什么樣的資源，都是通過使用相同的接口進行資源的訪問。接口應該使用標准的HTTP方法，如GET，POST，PUT，DELETE，並遵循這些方法的語義。

REST實例【1】

假設用戶正在訪問一個電商網站www.egoods.com。用戶登陸該網站進行購物時，首先需要在該網站上選擇其所需要尋找物品的分類，進而列出屬於該分類的各個物品。看似簡單的流程其實瀏覽器向服務器發送了多次請求：1，頁面加載時將得到所有商品分類，服務器將這些分類顯示在瀏覽器上。2，用戶選擇一個分類，瀏覽器請求該分類的詳細信息，服務器將該分類的所有商品顯示在瀏覽器上。3，用戶選擇商品，瀏覽器請求該產品的信息，服務器將該產品顯示在瀏覽器上。

1，向www.egoods.com/api/categories發送GET請求

GET /api/categories
Host: www.egoods.com
Authorization: Basic xxxxxxxxxxxxxxxxx
Accept: application/json

從服務器端返回的JSON

HTTP/1.1 200 OK
Content-Type: application/json
Content-Length: xxx
 
[
   {
      "label" : "食品",
      "url" : "/api/categories/food"
   }, {
      "label" : "服裝",
      "url" : "/api/categories/coat"
   }
   ...
   {
      "label" : "電子設備",
      "url" : "/api/categories/electronic"
   }
]

2, 向www.egoods.com/api/categories/food發送GET請求

GET /api/categories/food
Host: www.egoods.com
Authorization: Basic xxxxxxxxxxxxxxxxxx
Accept: application/json

從服務器端返回的JSON

HTTP/1.1 200 OK
Content-Type: application/json
Content-Length: xxx
 
{
   "url" : "/api/categories/food",
   "label" : "Food",
   "items_url" : "/api/items?category=food",
   "brands" : [
         {
            "label" : "友臣",
            "brand_key" : "32073",
            "url" : "/api/brands/32073"
         }, {
            "label" : "樂事",
            "brand_key" : "56632",
            "url" : "/api/brands/56632"
         }
         ...
   ],
   "hot_searches" : …
}

3, 瀏覽其中一種品牌

GET /api/items?category=food&brand_key=56632
Host: www.egoods.com
Authorization: Basic xxxxxxxxxxxxxxxxxx
Accept: application/json

HTTP Header

HTTP協議采用了請求／響應模型，瀏覽器或者其他客戶端發出請求，服務器給出相應。HTTP Header允許客戶端和服務器通過請求和響應傳遞附加信息。

Request Header:

Header	解釋	示例
Accept	指定客戶端能夠接收的內容類型	Accept: text/plain, text/html
Accept-Charset	瀏覽器可以接受的字符編碼集。	Accept-Charset: iso-8859-5
Accept-Encoding	指定瀏覽器可以支持的web服務器返回內容壓縮編碼類型。	Accept-Encoding: compress, gzip
Accept-Language	瀏覽器可接受的語言	Accept-Language: en,zh
Accept-Ranges	可以請求網頁實體的一個或者多個子范圍字段	Accept-Ranges: bytes
Authorization	HTTP授權的授權證書	Authorization: Basic QWxhZGRpbjpvcGVuIHNlc2FtZQ==
Cache-Control	指定請求和響應遵循的緩存機制	Cache-Control: no-cache
Connection	表示是否需要持久連接。（HTTP 1.1默認進行持久連接）	Connection: close
Cookie	HTTP請求發送時，會把保存在該請求域名下的所有cookie值一起發送給web服務器。	Cookie: $Version=1; Skin=new;
Content-Length	請求的內容長度	Content-Length: 348
Content-Type	請求的與實體對應的MIME信息	Content-Type: application/x-www-form-urlencoded
Date	請求發送的日期和時間	Date: Tue, 15 Nov 2010 08:12:31 GMT
Expect	請求的特定的服務器行為	Expect: 100-continue
From	發出請求的用戶的Email	From: [e-mail]
Host	指定請求的服務器的域名和端口號	Host: www.zcmhi.com
If-Match	只有請求內容與實體相匹配才有效	If-Match: “737060cd8c284d8af7ad3082f209582d”
If-Modified-Since	如果請求的部分在指定時間之后被修改則請求成功，未被修改則返回304代碼	If-Modified-Since: Sat, 29 Oct 2010 19:43:31 GMT
If-None-Match	如果內容未改變返回304代碼，參數為服務器先前發送的Etag，與服務器回應的Etag比較判斷是否改變	If-None-Match: “737060cd8c284d8af7ad3082f209582d”
If-Range	如果實體未改變，服務器發送客戶端丟失的部分，否則發送整個實體。參數也為Etag	If-Range: “737060cd8c284d8af7ad3082f209582d”
If-Unmodified-Since	只在實體在指定時間之后未被修改才請求成功	If-Unmodified-Since: Sat, 29 Oct 2010 19:43:31 GMT
Max-Forwards	限制信息通過代理和網關傳送的時間	Max-Forwards: 10
Pragma	用來包含實現特定的指令	Pragma: no-cache
Proxy-Authorization	連接到代理的授權證書	Proxy-Authorization: Basic QWxhZGRpbjpvcGVuIHNlc2FtZQ==
Range	只請求實體的一部分，指定范圍	Range: bytes=500-999
Referer	先前網頁的地址，當前請求網頁緊隨其后,即來路	Referer: http://www.zcmhi.com/archives/71.html
TE	客戶端願意接受的傳輸編碼，並通知服務器接受接受尾加頭信息	TE: trailers,deflate;q=0.5
Upgrade	向服務器指定某種傳輸協議以便服務器進行轉換（如果支持）	Upgrade: HTTP/2.0, SHTTP/1.3, IRC/6.9, RTA/x11
User-Agent	User-Agent的內容包含發出請求的用戶信息	User-Agent: Mozilla/5.0 (Linux; X11)
Via	通知中間網關或代理服務器地址，通信協議	Via: 1.0 fred, 1.1 nowhere.com (Apache/1.1)
Warning	關於消息實體的警告信息	Warn: 199 Miscellaneous warning

 

Response Header：

Header	解釋	示例
Accept-Ranges	表明服務器是否支持指定范圍請求及哪種類型的分段請求	Accept-Ranges: bytes
Age	從原始服務器到代理緩存形成的估算時間（以秒計，非負）	Age: 12
Allow	對某網絡資源的有效的請求行為，不允許則返回405	Allow: GET, HEAD
Cache-Control	告訴所有的緩存機制是否可以緩存及哪種類型	Cache-Control: no-cache
Content-Encoding	web服務器支持的返回內容壓縮編碼類型。	Content-Encoding: gzip
Content-Language	響應體的語言	Content-Language: en,zh
Content-Length	響應體的長度	Content-Length: 348
Content-Location	請求資源可替代的備用的另一地址	Content-Location: /index.htm
Content-MD5	返回資源的MD5校驗值	Content-MD5: Q2hlY2sgSW50ZWdyaXR5IQ==
Content-Range	在整個返回體中本部分的字節位置	Content-Range: bytes 21010-47021/47022
Content-Type	返回內容的MIME類型	Content-Type: text/html; charset=utf-8
Date	原始服務器消息發出的時間	Date: Tue, 15 Nov 2010 08:12:31 GMT
ETag	請求變量的實體標簽的當前值	ETag: “737060cd8c284d8af7ad3082f209582d”
Expires	響應過期的日期和時間	Expires: Thu, 01 Dec 2010 16:00:00 GMT
Last-Modified	請求資源的最后修改時間	Last-Modified: Tue, 15 Nov 2010 12:45:26 GMT
Location	用來重定向接收方到非請求URL的位置來完成請求或標識新的資源	Location: http://www.zcmhi.com/archives/94.html
Pragma	包括實現特定的指令，它可應用到響應鏈上的任何接收方	Pragma: no-cache
Proxy-Authenticate	它指出認證方案和可應用到代理的該URL上的參數	Proxy-Authenticate: Basic
refresh	應用於重定向或一個新的資源被創造，在5秒之后重定向（由網景提出，被大部分瀏覽器支持）	Refresh: 5; url= http://www.zcmhi.com/archives/94.html
Retry-After	如果實體暫時不可取，通知客戶端在指定時間之后再次嘗試	Retry-After: 120
Server	web服務器軟件名稱	Server: Apache/1.3.27 (Unix) (Red-Hat/Linux)
Set-Cookie	設置Http Cookie	Set-Cookie: UserID=JohnDoe; Max-Age=3600; Version=1
Trailer	指出頭域在分塊傳輸編碼的尾部存在	Trailer: Max-Forwards
Transfer-Encoding	文件傳輸編碼	Transfer-Encoding:chunked
Vary	告訴下游代理是使用緩存響應還是從原始服務器請求	Vary: *
Via	告知代理客戶端響應是通過哪里發送的	Via: 1.0 fred, 1.1 nowhere.com (Apache/1.1)
Warning	警告實體可能存在的問題	Warning: 199 Miscellaneous warning
WWW-Authenticate	表明客戶端請求實體應該使用的授權方案	WWW-Authenticate: Basic

 

【1】摘錄自：REST簡介

附：Reponse Code

Reponse消息中第一行叫做狀態行，由HTTP協議版本號，狀態碼，狀態消息三部分組成。

狀態碼用來告訴HTTP客戶端，HTTP服務器是否產生了預期的Response。

HTTP/1.1中定義了5類狀態碼，

1xx 提示信息 - 表示請求已被成功接收，繼續處理

2xx 成功 - 表示請求已被成功接收，理解，接收

3xx 重定向 - 要完成請求必須進行更進一步的處理

4xx 客戶端錯誤 - 請求由語法錯誤或請求無法實現

5xx 服務器端錯誤 - 服務器未能實現合法的請求