跳到主要內容

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說明，但我沒有具體的使用案例，有興趣的可以參考這篇。

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。詳情可以參考link。
  • ETag+If-None-match: 方法類似上一個，只是Server回應的東西叫ETag；這是一個資源的代號，可以是內容的hash，也可以是版本號。詳情可以參考link。

4xx - Client Error

400 - Bad Request

400算是通用的Client Error。在軟體開發初期，如果嫌分類麻煩，可以使用它來告訴Client Request有問題。通常只要Client輸入的參數驗證不通過，我就會丟400給它；至於訊息夠不夠清楚，就看良心了。

401 - Unauthorized

這是用來通知Client所要存取的資源必須經過認證，通常也可以拿來代表使用者的帳號或密碼有問題。

403 - Forbidden

這是用來通知Client存取權限不足。舉例來說:

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。舉例來說:

  • 將某資源名稱修改為已存在之名稱。
  • 刪除不含有子資源的資源。
  • 操作已被修改的資源；在GitHub中，如果要Merge已被其他人修改過的Branch，就會收到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。

Note .如果例外懶得處理，即使回傳500給Client，也不要丟400讓它們覺得有任何希望..

503 - Service Unavailable

這代表著伺服器暫時無法提供服務。通常代表伺服器在進行維護或者是因為過載而暫時無法提供服務。

Reference

標籤：

留言

張貼留言

這個網誌中的熱門文章

解決RobotFramework從3.1.2升級到3.2.2之後，Choose File突然會整個Hand住的問題

考慮到自動測試環境的維護，我們很久以前就使用java去執行robot framework。前陣子開始處理從3.1.2升級到3.2.2的事情，主要先把明確的runtime語法錯誤與deprecate item處理好，這部分內容可以參考: link 。 直到最近才發現，透過SeleniumLibrary執行Choose File去上傳檔案的動作，會導致測試案例timeout。本篇文章主要分享心路歷程與解決方法，我也送了一條issue給robot framework: link 。 我的環境如下: RobotFramework: 3.2.2 Selenium: 3.141.0 SeleniumLibrary: 3.3.1 Remote Selenium Version: selenium-server-standalone-3.141.59 首先並非所有Choose File的動作都會hang住，有些測試案例是可以執行的，但是上傳一個作業系統ISO檔案一定會發生問題。後來我透過wireshark去比對新舊版本的上傳動作，因為我使用 Remote Selenium ，所以Selenium會先把檔案透過REST API發送到Remote Selenium Server上。從下圖我們可以發現，在3.2.2的最後一個TCP封包，比3.1.2大概少了500個bytes。 於是就開始了我trace code之路。包含SeleniumLibrary產生要送給Remote Selenium Server的request內容，還有HTTP Content-Length的計算，我都確認過沒有問題。 最後發現問題是出在socket API的使用上，就是下圖的這支code: 最後發現可能因為開始使用nio的方式送資料，但沒處理到尚未送完的資料內容，而導致發生問題。加一個loop去做計算就可以解決了。 最後我有把解法提供給robot framework官方，在他們出新的版本之前，我是將改完的_socket.py放在我們自己的Lib底下，好讓我們測試可以正常進行。(shutil.py應該也是為了解某個bug而產生的樣子..)
張貼留言
閱讀完整內容

第一次寫MIB就上手

SNMP(Simple Network Management Protocol)是用來管理網路設備的一種Protocol，我對它的認識也是從工作接觸開始。雖說是管理網路設備，但是主機、電源供應器、RAID等也都可以透過它來做管理。如果你做了一個應用程式，當然所有的操作也都可以透過SNMP來完成，不過可能會很痛苦。前陣子遇到一個學弟，它告訴我說:「我可能不會想寫程式。」為什麼? 因為這是他痛苦的根源。 在這篇文章中，不是要告訴你SNMP是什麼，會看這篇文章的大哥們，應該已經對SNMP有些認識了。 是的!主題是MIB(Management information base)! 對於一個3th-party的SNMP oid，有MIB可以幫助你去了解它所提供的資訊是什麼，且可以對它做什麼操作。最近我運氣很好剛好做到關於修改MIB的工作，也讓我順便了解一下它的語法，接下來我要交給大家MIB的基礎認識。 smidump 我並非使用什麼高強的Editor去編寫MIB，我僅透過Nodepad++編輯和smidump編譯而已。smidump是Kay教我使用的一個將MIB module轉成樹狀結構或oid列表的工具，唯一的缺點是不會告訴你哪一行打錯。當然有錢直接買編輯樹狀結構的工具就可以不需要了解語法了! 安裝 在Ubuntu上可先輸入smidump確認是否安裝，如果沒安裝可透過apt-get install libsmi2ldbl安裝。(CentOS可以透過yum install libsmi) root@tonylin:~/multi-boot-server# smidump The program 'smidump' is currently not installed. You can install it by typing: apt-get install libsmi2ldbl 使用 透過下面兩行指令，就可以將mib file產生出對應的tree與oid列表的檔案。也可以透過這個結果確認MIB是不是你想要的。 smidump -f tree example1.mib > xtree.txt smidump -f identifiers example1.mib > xiden.txt 如果有參考其它檔案要加上p的參數: smidum...
張貼留言
閱讀完整內容

Windows DLL - 32-bit dll with 64-bit driver

前言 在64-bit作業系統上所使用的驅動程式，一定是64-bit，然而應用程式卻可能是32或64-bit。當32-bit應用程式傳值給驅動程式時是有可能會發生溢位的。主要原因是32與64-bit指標所佔用記憶體長度的不同。接下來我將透過Reference 1中的程式PhyMem，來告訴大家問題在哪與如何修改。(最後改完的程式碼恕我不提供) PhyMem介紹 這是一個中國人寫的程式。作用與WinIO相同，可以存取windows的io port與physical memory。這個程式包含pmdll、driver與test三個專案，分別產生dll、sys與exe。作者僅提供32-bit的版本，但只要修改編譯設定就可以讓它產生出64-bit的artifact。但如同我前言所說，如果你是32-bit的dll要存取64的sys該怎麼辦? 可以規定User在64-bit的OS用64-bit的應用程式就好了阿! 但是將一個32-bit應用程式改為64-bit的有這麼簡單嗎? 除此之外，中間傳遞的資料型態也會影響到正常功能。 設定driver專案 我開發環境是VC2008與DDK6000，下載Reference1的專案是無法直接編譯的，可以參考我的設定去修改編譯、連結參數。輸出檔可以看個人需求，根據32或64命名，或者是用同一個檔案名稱。 32-bit C/C++ > 一般 > 其它Include目錄($(DDKROOT)為設定於環境變數的DDK安裝目錄): $(DDKROOT)\inc\ddk";"$(DDKROOT)\inc\api";"$(DDKROOT)\inc\crt";"$(DDKROOT)\inc\crt\gl";"$(DDKROOT)\inc\crt\sys" 連結器 > 一般 > 其它程式庫目錄: $(DDKROOT)\lib\wnet\i386。 連結器 > 資訊清單檔: 將產生資訊清單與UAC選擇否，因為這不適用於driver。 連結器 > 進階 > 隨機化的基底位置: 選擇預設。 64-bit Reference1僅提供32-bit設定。64-bit可在建置>組態管理員中，新增x64平台，而設定檔可從win32複製過來修...
張貼留言
閱讀完整內容