2-1.ASP.NET Core Web API 入門教學 - RESTful API基本觀念與Postman基本操作

ASP.NET Core Web API 入門教學

RESTful 是一個撰寫風格設計規範,用這個風格寫出來的API就叫做RESTful API

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

功能方法網址
取得新聞列表GETapi/news/getAllList
取得一則新聞GETapi/news/getItem/1
新增一則新聞POSTapi/news/new
更新一則新聞POSTapi/news/update
刪除一則新聞POSTapi/news/delete

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

功能方法網址
取得新聞列表GETapi/news/getList
取得一則新聞GET api/news/getOne/1
新增一則新聞POSTapi/news/newOne
更新一則新聞POSTapi/news/updateOne
刪除一則新聞POSTapi/news/delete/1

但採用RESTful API風格開發

功能方法網址
取得新聞列表GETapi/news
取得一則新聞GET api/news/1
新增一則新聞POSTapi/news
更新一則新聞PUTapi/news/1
刪除一則新聞DELETEapi/news/1

簡單來講就是讓風格變得一致,且利用不同的Method讓網址變得簡潔

維護上就會變得清楚,別人也可以更快理解其他人的API接口作用

RESTful API其實並非什麼神奇或有特殊功能的東西,它僅僅就是一個寫作的風格

以下簡單說明各方法(Method)使用情境

GET:取得資料。

POST:新增資料。

PUT:更新資料。

DELETE:刪除資料。

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

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


接著,再來介紹一款好用的讀取API的軟體Postman,這邊下載

承上一個影片提到,瀏覽器如果要使用GET之外的存取方式比較不適合,甚至下一些參數,所以我們需要另一個軟體來做這件事

這邊就可以使用Postman來測試我們寫好的API

這邊帶著大家安裝一次,首先先到官網下載,下載好就直接執行

右上角可以選擇要不要登入,登入後到不同電腦,也可以看到別台電腦輸入的內容

接著大家可以打開我的範例檔來試一下使用Postman的感覺,按下左上角的+開始讀取範例檔的API

以下GET取得HelloWorld列表

以下GET取得一個指定ID為1的HelloWorld

以下POST一個新增傳值HelloWorld4

以下PUT一個ID為4且更新傳值為HelloWorld4

以下DELETE一個ID為4的

這邊先簡單示範一下Postman的使用方法,後續會一面實作API一面使用Postman

所以其他Postman的用法,到時候碰到在學就好,現在這邊先簡單介紹到這邊就好

範例檔:下載




Copyright © 凱哥寫程式 2022 | Powered by TalllKai ❤