差異處
這裏顯示兩個版本的差異處。
|
java:web:restapi:response_code [2019/01/22 22:31] tony |
java:web:restapi:response_code [2023/06/25 09:48] |
||
|---|---|---|---|
| 行 1: | 行 1: | ||
| - | ====== 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與Server溝通時，Server會回應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 === | ||
| - | 代表Server處理了部分的GET請求，這通常用於續傳的功能。之前曾經在Camel Netty上實做這個以達到藉由HTTP掛載ISO的功能。 | ||
| - | ===== 3xx - Redirection ===== | ||
| - | 原本要撰寫302、303與307說明，但我沒有具體的使用案例，有興趣的可以參考[[https://www.cnblogs.com/cswuyg/p/3871976.html|這篇]]。 | ||
| - | === 301 - Moved Permanently === | ||
| - | 這代表請求資源已經被移到新的位置，新的URI回描述於Response Location Header，通常用於API改版。 | ||
| - | === 304 - Not Modified === | ||
| - | 與204類似，是用來減少溝通的頻寬。通常用於GET加上條件，Server會根據條件告訴你資源是否有被修改，假如沒修改Client就可以直接讀Cache。目前已知的兩種下條件方式: | ||
| - | * Last-Modified+If-Modified-Since: Server會在請求的資源Header加入Last-Modified去描述修改時間，Client第二次請求會於Header將此值帶入If-Modified-Since，假如Server發現沒有修改，會直接回應304。詳情可以參考[[https://tools.ietf.org/html/rfc7232#section-2.2|link]]。 | ||
| - | * ETag+If-None-match: 方法類似上一個，只是Server回應的東西叫ETag；這是一個資源的代號，可以是內容的hash，也可以是版本號。詳情可以參考[[https://tools.ietf.org/html/rfc7232#section-2.3|link]]。 | ||
| - | ===== 4xx - Client Error ===== | ||
| - | === 400 - Bad Request === | ||
| - | 400算是通用的Client Error。在軟體開發初期，如果嫌分類麻煩，可以使用它來告訴Client Request有問題。 | ||
| - | === 401 - Unauthorized === | ||
| - | 這是用來通知Client所要存取的資源必須經過認證，通常也可以拿來代表使用者的帳號或密碼有問題。 | ||
| - | === 403 - Forbidden === | ||
| - | 這是用來通知Client存取權限不足。通常用於Client認證通過，但沒有權限可以存取某些特定資源所回應的錯誤碼。 | ||
| - | === 404 - Not Found === | ||
| - | 這是用來通知Client所要存取的資源URI並不存在。 | ||
| - | === 405 - Method Not Allowed === | ||
| - | 假如Server資源只支援GET，但Client使用了其它種類的操作；Server可以回應405，並加上Allow: GET Header通知Client所支援的HTTP Method。 | ||
| - | === 406 - Not Acceptable === | ||
| - | 假如Server資源只接受application/json，但Client透過Accept Header或者是特定Query String指定了其它的media type，Server可以回應此錯誤碼通知Client。 | ||
| - | === 409 - Conflict === | ||
| - | 當Client所做的操作會讓資源狀態發生問題時，Server可以回應409。舉例來說，將某資源名稱修改為已存在之名稱；刪除不含有子資源的資源；操作已被修改的資源等。 | ||
| - | === 412 Precondition Failed === | ||
| - | 這用來代表Client請求Header中的條件無法滿足。舉例來說，Client想透過PUT修改某樣資源，它在Header中指定了If-Match，當伺服器發現If-Match無法吻合時，就會丟412。這個目前我還沒有實際的應用可以舉例。 | ||
| - | === 415 - Unsupported Media Type === | ||
| - | 這代表著Server無法處理Client所指定的Content-Type。舉例來說，Client發送了xml格式，但Server只支援json，因此回應了415。 | ||
| - | ===== 5xx - Server Error ===== | ||
| - | === 500 - Internal Server Error === | ||
| - | 這應該是最不陌生的錯誤代碼了。假如Server發生非預期的錯誤，最簡單就是直接將例外抓起，回應此代碼給Client。 | ||
| - | |||
| - | |||
| - | ===== Reference ===== | ||
| - | * REST API Design Rulebook, 1st Edition, by Mark Masse | ||
| - | * [[https://blog.miniasp.com/post/2009/01/16/Web-developer-should-know-about-HTTP-Status-Code.aspx|網頁開發人員應了解的 HTTP 狀態碼]] | ||
| - | * [[https://zh.wikipedia.org/wiki/HTTP%E7%8A%B6%E6%80%81%E7%A0%81|HTTP狀態碼]] | ||
