這是本文件的舊版!
REST API - Response Code
Introduction
最近同事在review REST API的例外處理程式碼時,發現某些API居然針對所有例外,都是使用400的Response code。我看到時相當訝異,也因此希望能給新人上一課,關於REST API的基礎知識。本篇文章,主要分享常見的Response Code的意義與使用時機。
Categories
Http Response Code分五類,
- 1xx: Informational;這類屬於Protocol操作相關的回應碼。
- 2xx: Success;這類屬於請求有被接收的回應碼。
- 3xx: Redirection;這類屬於必須做進一步的動作才能完成請求的回應碼。
- 4xx: Client Error;這類屬於Client相關的錯誤碼,代表Client只要調整請求方式,就能請求成功。
- 5xx: Server Error;這類屬於Server相關的錯誤碼,代表Server發生問題無法處理請求。
從上述內容,其實就能夠得知,假如我們將所有錯誤都以4xx回應,會讓使用者誤以為是他們的問題。接下來將會針對個別種類中,常見的回應碼做說明。
1xx - Informational
1xx的種類,在目前我們提供的REST API中,並沒有這種回應碼。目前我知道的實際案例,只有在使用StartSTL與伺服器溝通時,伺服器會回應101 Switching Protocols通知我們將連線從一般連線Upgrade為TLS連線;這部分如果以後有使用到再分享。
2xx - Success
200 - OK
最常見的回應碼,代表著請求成功且包含Response Body,通常用於HTTP GET。假如用在POST,應攜帶操作結果的描述。
201 - Created
用於POST,代表資源的新增。在Response中,會包含名為Location的Header,指出新資源的URI。
202 - Accepted
通常用於非同步操作,代表著工作已被接受,但不意味著最後會成功。假如你的API會Blocking很長時間,可以使用非同步做法,可先返回202與工作相關資訊,去減少不必要的等待。
204 - No Content
代表請求成功且沒有Response Body。可用於PUT、POST與DELETE,也可以用於GET去代表資源存在但沒有內容。
206 - Partial Content
代表伺服器處理了部分的GET請求,這通常用於續傳的功能。之前曾經在Camel Netty上實做這個以達到藉由HTTP掛載ISO的功能。
3xx - Redirection
301 - Moved Permanently
這代表請求資源已經被移到新的位置,新的URI回描述於Response Location Header,通常用於API改版。
Reference
- REST API Design Rulebook, 1st Edition, by Mark Masse