用ASP.NET Core 2.0 建立規範的 REST API -- GET 和 POST

標籤：匿名類   知識   not found   nal   過濾   employee   develop   web   table   

本文轉自：https://www.cnblogs.com/cgzl/archive/2018/05/23/9047626.html

本文所需的一些預備知識可以看這裡: http://www.cnblogs.com/cgzl/p/9010978.html 和 http://www.cnblogs.com/cgzl/p/9019314.html

本文介紹的是使用ASP.NET Core建立Richardson成熟度等級為2級的偽RESTful web API, 本文介紹的是GET和POST.

使用的項目是(右鍵另存新檔, 然後把尾碼名改為zip): https://images2018.cnblogs.com/blog/986268/201805/986268-20180516191053536-1701412182.jpg

RESTful API 資源 (Resource) 的命名指導規範

首先, 資源應該使用名詞, 它是個東西, 不是動作.

例如:

• api/getusers 就是不正確的.
• GET api/users 就是正確的
• GET api/users/{userId}.

所以資源應該使用的是名詞.

如果是非分層結構的資源, 那麼它不應該這樣命名: api/xxx/xxx/users, 而應該使用 api/users.

如果是單個資源, 不應該這樣 api/id/users, 而應該是 api/users/{userId}.

(資源名是否複數還是根據個人習慣吧).

命名應該可以體現資源的結構

例如 api/department/{departmentId}/emoloyees, 這就表示了department (部門)和 員工(employee)之前是主從關係.

而 api/department/{departmentId}/emoloyees/{employeeId}, 就表示了該部門下的某個員工.

 

而過濾, 排序等不是資源, 所以這樣寫 api/users/orderby/username 是不正確的.

過濾排序這類的參數是可以作為查詢參數傳遞進來的, 正確的寫法應該是: api/users?orderby=username.

但是有時候, RPC風格的方法調用很難映射成規範的資源命名, 所以有時可以打破規範 例如 api/users/{userId}/totalsalaries.

 

應該使用什麼類型作為ID

如果使用int型作為ID的話, 大部分時候是沒有問題的, 但是如果您使用的資料庫的ID是自增整型的, 如果你替換資料庫了, 然後把原有資料移轉到新資料庫了, 那麼現有資料的ID就會發生變化, 那麼相當於所有的資源的地址發生了變化, 這就違反了這個:

資源的URI應該永遠都是一樣的.

所以GUID應該作為ID來使用. (但是我為了省事, 還是使用自增int作為ID吧??).

使用GUID作為主鍵的好處就是:

• 可以切換資料庫
• 一定層度上隱藏了內部實現細節

通過HTTP方法與資源互動

針對項目裡的Country這個資源, 請參考下面這個列表:

這裡GET可以理解為擷取(查詢)資源, POST為添加資源, PUT為整體更新資源, PATCH為局部更新資源, DELETE為刪除資源.

這裡需要提的是後兩個:

• HEAD: 和GET差不多, 但是它不應該返迴響應的body, 所有沒有響應的payload. 它主要使用來擷取資源的一些資訊, 例如查看資源是否可用等.
• OPTIONS: 它是用來查詢某個資源URI的可互動方式有哪些, 換句話說就是, 使用它可以知道某個URI是否可以執行GET或者POST動作, 這些結果通常是在響應的Headers裡面而不是body裡, 所以也沒有響應的payload.

建立Controller

首先需要建立一個CountryController:

注意在CountryController上面標註的[Route]屬性標籤，它的值是整個Controller下所有的Action的路由首碼，可以寫成固定的地址，也可以寫成"api/[controller]", 其中[controller]這部分會變成這個Controller的名字，這裡也就是"api/country".

如果使用[controller]的話，如果Controller重構後名字改了，那麼該Controller的路由地址也就是資源的地址也就改了，這樣很不好，所以建議還是寫成固定的地址不要使用[controller]。

GET 資源

GET 所有的Country：

（AutoMapper的使用方法這裡就不介紹了）

 GET 一個Country：

 

這兩個方法裡返回的都是JsonResult，這看起來沒什麼問題，因為我們想要的就是JSON格式的結果。以第二個方法為例，使用POSTMAN測試，如果能查詢到資料：

這是沒有問題的，但是如果查詢一個不存在的資源：

這就有問題了，如果查詢不到資源，那麼返回的應該是404 NOF FOUND 而不是200 OK.

狀態代碼

狀態代碼是非常重要的，因為只有狀態代碼會告訴API的消費者：

• 請求是否如預期的成功，或者失敗
• 如果出現了錯誤，誰該為這個錯誤負責

下面再列舉一下web API會用到的狀態代碼：

200層級，表示成功：

• 200 - OK
• 201 - Created，表示資源建立成功了
• 204 - No content，成功執行，但是不應該返回任何東西

400層級，表示用戶端引起的錯誤：

• 400 - Bad request，表示API的消費者發送到伺服器的請求是錯誤的
• 401 - Unauthorized，表示沒有許可權
• 403 - Forbidden，表示使用者驗證成功，但是該使用者仍然無法訪問該資源
• 404 - Not found，表示請求的資源不存在
• 405 - Method not allowed，這就是當我們嘗試發送請求給某個資源時，使用的HTTP方法卻是不允許的，例如使用POST api/countries, 而該資源只實現了 GET，所以POST不被允許
• 406 - Not acceptable，這裡涉及到了media type，例如API消費者請求的是application/xml格式的media type，而API只支援application/json
• 409 - Conflict，表示該請求無法完成，因為請求與當前資源的狀態有衝突，例如你編輯某個資源資料以後，該資源又被其它人更新了，這時你再PUT你的資料就會出現409錯誤；有時也用在嘗試建立資源時該資源已存在的情況。
• 415 - Unsupported media type，這個和406正好返回來，比如說我向伺服器提交資料的media type是xml的，而伺服器只支援json，那麼就會返回415
• 422 - Unprocessable entity，表示請求的格式沒問題，但是語義有錯誤，例如實體驗證錯誤。

500層級，伺服器錯誤：

• 500 - Internal server error，這表示是伺服器發生了錯誤

 

回到剛才的那兩個方法，預設情況下 JsonResult會返回200 OK狀態代碼，可以去修改JsonResult以支援其它的狀態代碼。但是Controller裡提供了一些協助方法返回IActionResult並指定特定的狀態代碼，針對200，就是Ok()方法。

這時就不需要手動返回JsonResult了。

這裡需要注意的是，針對集合的內容協商，如果集合是空的，也不應該返回404，因為這個Country資源是存在的，只不過它的內容是空的而已。

然後看一下GET 特定單個資源：

針對單個資源，如果沒有找到，就需要返回404 Not Found，這時就可以使用Controller的協助方法 NotFound().

 

處理異常

當Action發生異常的時候，預設情況下ASP.NET Core會返回500：

但還是自己處理一下比較好，可以在Action裡面使用try catch:

這裡由於是伺服器的錯誤，所以應該返回500狀態代碼 Internal Server Error。

注意這裡不應該返回Exception，因為這是程式的內部實現細節，再說它對客戶來說也沒什麼用。

此外，我們還可以全域處理異常。

在Startup裡面的Configure方法：

使用app.UseExceptionHandler()，裡面可以自訂一些邏輯。如果這地方代碼比較多的話，可以把它封裝成一個擴充方法，然後使用app.Usexxx的形式調用。

回頭我把Action裡面的try catch去掉試試，但是這裡要注意把環境變數ASPNETCORE_ENVIRONMENT的值改成Production（其實不是Development就可以）：

 

GET 父子關係的資源

這是一個典型的情景，一個國家包含多個城市，這就是父子關係。

首先看一下domain model：

這個應該很簡單。

此外還要建立CityResource，Repository和IRepository，註冊配置，種子資料等等，這些就不貼了。

下面建立CityController

前面提到過，針對父子、主從關係的資源，其子資源的路由地址應該是上面這樣的，由於該Controller下所有的Action的路由首碼都是一樣的，所以把這個路由放到了Controller層級作為所有Action的首碼。

而GET方法本身比較簡單，沒什麼說的，裡面涉及的一些方法請自行編寫。

看看運行結果：

如果找不到Country，則返回404：

 

下面GET 單個city：

注意，單個資源找不到就應該返回404，而空集合怎不是，這個前面也提過。

找到資源的結果：

找不到country或者city的時候都應該返回404，就不貼圖了。

 

內容協商

簡單來說就是，如果資源支援多種展現格式，那麼消費者可以選擇它想要的格式。

這裡就要用到media type，它可以通過請求的Accept Header來傳遞，常見的有：

application/json 和 application/xml...等等

在沒有指定Accept Header的情況下，就該返回一個預設的格式，在ASP.NET Core 2.0裡面就是application/json。

當請求的media type停用時候，並且消費者不支援預設格式，這時伺服器就應該返回 406 Not Acceptable 狀態代碼。

ASP.NET Core 支援輸出和輸入兩種格式化器。

輸出的media type在accept header裡面，而輸入的media type在content-type header裡面。

看一下當前的情況，請求的Accept Header為application/json時：

請求的Accept Header為application/xml時：

它們返回的都是json格式的。

因為伺服器（項目）現在不支援xml，所以返回了預設的json格式，但嚴格來說，這樣做不正確，所以需要處理一下。

在Startup裡，ConfigureServices方法：

把這個ReturnHttpNotAcceptable屬性設為true，如果想要的格式不支援，那麼就會返回406 Not Acceptable:

不指定Accept Header的情況下就返回預設的json格式：

下面，為項目添加Xml輸出格式的支援：

再試試：

這時就成功的返回了xml。

 

建立資源

首先瞭解一下方法的安全性和等冪性。

安全性是指方法執行後並不會改變資源的表述。

等冪性是指方法無論執行多少次都會得到同樣的結果。

下面是HTTP方法的安全性和等冪性列表：

參考這個列表可以協助決定在某種情況下用哪種HTTP方法。

下面看看建立Country的代碼：

這個代碼很簡單，資料是從請求的body帶進來的。

需要注意的是返回什麼，如果POST操作執行成功的話，標準的做法是返回201 Created 狀態代碼。

在這裡就可以使用CreatedAtRoute() 這個方法，它允許響應裡帶著Location Header，在這個Location Header裡包含著一個uri，通過這個uri就可以GET到我們剛剛建立好的資源（Country）。

這個方法的第一個參數是一個路由名，使用這個路由名可以用來產生剛才提到的uri。在本例裡，這個路由名應該對應的是GetCountry這個Action方法，所以為這個Action添加路由名：

這樣就和Post方法返回中用到的路由名一致了，第二個參數是一個匿名類裡面有個屬性id，它會編程路由裡的參數，最後一個參數是響應會返回的資料。

下面進行測試，發送請求的時候別忘了設定Content-type為applicaiton/json:

然後是資料：

然後發送請求，查看響應的body部分：

 

再看響應的header：

這裡可以看到Location Header的uri，通過這個uri，你就可以GET到這個剛剛建立的Country資源，這裡我就不測試了。

 

如果再次執行這個POST操作，看看結果：

這次返回的資料的id為6，與前面不一樣，所以POST不是等冪的，它每次執行後的結果是不一樣的。

 

建立子資源

Country的建立做完了，現在可以建立City了。

這個跟上面的差不多，只不過注意需要一下路由的參數即可。

測試：

 

同時建立父子資源

這是個常見的需求，一個Country和它下屬的Cities同時被傳遞進來，然後在Action裡一同建立。

首先需要修改CountryAddResource：

然後，就沒有然後了，所有的映射操作都交給AutoMapper和EntityFramework Core了。。

測試：

然後GET這兩個Cities：

 

建立集合資源

這次我要一次性添加一個集合的Countries。

由於Country的集合相當於是另外一種資源，所以可以把它放到單獨的Controller裡面，不放也沒問題。

這個其實也沒什麼特別的，注意傳進來的參數是IEnumerable。為了方便，暫時先返回OK()。

測試：

OK, 下面解決返回的問題.

我們要返回的是CreatedAtRoute方法, 由於裡面要包含可以返回該集合資源的路由地址, 所以需要建立一個Action, 它的參數應該是POST方法返回資料的Id的集合. 但是由於路由參數不支援集合形式, 只能以字串形式傳遞, 所以可以做成這樣的路由參數: api/xx/(1,2,3,4,5).

而Action方法呢, 接受的參數應該是Id的集合, 應該是一個集合類型, 所以我們可以使用ModelBinder把id字串轉化為id的集合:

然後, 還需要對應這個POST Action 做一個GET集合的Action 方法:

 

這個Action所期待的參數類型是Id的集合, 而實際傳入的是id的字串, 通過ArrayModelBinder來實現轉化.

最後修改POST方法的返回:

測試一下:

然後再GET這個連結:

 

OK

 

如果POST到單個資源的地址

如果POST到這個地址 http://localhost:5000/api/countries/{id}, 

那麼, 如果該id的資源不存在, 則應該返回404;

如果該id的資源存在, 則應該返回409 Conflict.

(POST不是等冪性的, 它無法多次請求都產生同樣的結果).

測試一下id的資源不存在的情況:

在測試一下Id的資源存在的情況:

還是404, 這個不行, 所以需要手動處理:

看看結果:

OK, 無論是Id存在的資源還是不存在的資源都會返回正確的狀態代碼.

 

支援輸入其它類型的Content-Type

之前講過如何返回xml的格式, 下面介紹一下如何使用xml格式進行請求, 首先在Startup.cs裡面添加這個:

然後, 需要把請求的Content-Type設為application/xml:

我就不適用xml資料進行測試了.

 

這次先到這, 隨後會寫DELETE, UPDATE, PATCH.

本文的源碼地址: https://github.com/solenovex/ASP.NET-Core-2.0-RESTful-API-Tutorial

用ASP.NET Core 2.0 建立規範的 REST API -- GET 和 POST