ASP.NET Core .NET 5 打造WebAPI入門教學(3_1) - 什麼是RESTful API,以它為開發風格的基礎

RESTful 是一個撰寫風格，用這個風格寫出來的API就叫做RESTful API

沒有規範時寫一個todo用的API可能會像以下

取得todo清單 GET   api/todo/getAllList
取得指定todo GET   api/todo/getItem/1

新增一筆todo POST api/todo/new

更新指定todo POST  api/todo/update

刪除指定todo POST  api/todo/delete

另一個人寫可能會變成以下這樣

取得todo清單 GET   api/todo/getList
取得指定todo GET   api/todo/getOne/1

新增一筆todo POST api/todo/new

更新指定todo POST  api/todo/updateOne

刪除指定todo POST  api/todo/delete/1

但採用RESTful API風格開發

取得todo清單 GET   api/todo
取得指定todo GET   api/todo/1

新增一筆todo POST api/todo

更新指定todo PUT  api/todo/1

刪除指定todo DELETE api/todo/1

簡單來講就是讓風格變得一致，且利用不同的Method讓網址變得簡潔
維護上就會變得清楚，別人也可以更快理解其他人的API接口作用
RESTful API其實並非什麼神奇或有特殊功能的東西，它僅僅就是一個寫作的風格

以下簡單說明各Method使用情境

GET：取得資料。
POST：新增一項資料。
PUT：更新指定資料，當無指定資料時新增。

PATCH：更新指定資料部分欄位。
DELETE：刪除指定資料。

以上只是定義，但實際還是會依情況進行適當的調整，出現例外並沒有關係。

怕自己風格用的不精準？其實這部分很自由心證，不要太離譜就行，或者同公司有共識即可。