drf : web應用模式，RESTful API規範，介面測試工具：Postman

冀未然發表於2024-03-25
Web模式RESTAPIPostman

drf : web應用模式，RESTful API規範，介面測試工具：Postman

Web應用模式

前後端不分離
前後端分離

API介面

前後端互動的媒介

Web API介面和一般的url連結還是有區別的，Web API 介面簡單概括有下面四大特點。

  • url：長得像返回資料的url連結
    https://api.map.baidu.com/place/v2/search

  • 請求方式：get、post、put、patch、delete
    採用get方式請求上方介面

  • 請求引數：json或xml格式的key-value型別資料

    • ak：6E823f587c95f0148c19993539b99295
    • region：上海
    • query：肯德基
    • output：json

  • 響應結果：json或xml格式的資料

    • 上方請求引數的output引數值決定了響應資料的格式
    • 資料

xml格式

https://api.map.baidu.com/place/v2/search?ak=6E823f587c95f0148c19993539b99295&region=%E4%B8%8A%E6%B5%B7&query=%E8%82%AF%E5%BE%B7%E5%9F%BA&output=xml
#json格式
https://api.map.baidu.com/place/v2/search?ak=6E823f587c95f0148c19993539b99295&region=%E4%B8%8A%E6%B5%B7&query=%E8%82%AF%E5%BE%B7%E5%9F%BA&output=json
{
   "status":0,
 	"message":"ok",
   "results":[
       {
           "name":"肯德基(羅餐廳)",
           "location":{
               "lat":31.415354,
               "lng":121.357339
           },
           "address":"月羅路2380號",
           "province":"上海市",
           "city":"上海市",
           "area":"寶山區",
           "street_id":"339ed41ae1d6dc320a5cb37c",
           "telephone":"(021)56761006",
           "detail":1,
           "uid":"339ed41ae1d6dc320a5cb37c"
       }
     	...
   	]
}

介面測試工具：Postman

介面測試工具其本質均為模擬傳送HTTP的請求。

Postman是一款介面除錯工具，是一款免費的視覺化軟體，同時支援各種作業系統平臺，是測試介面的首選工具。

Postman可以直接從官網：https://www.getpostman.com/downloads/下載獲得，然後進行傻瓜式安裝。

工作皮膚
img

簡易的get請求
img

簡易的post請求
img

案例：肯德基請求百度地圖介面
img

RESTful API規範

restful

REST全稱是Representational State Transfer，中文意思是表述（編者注：通常譯為表徵性狀態轉移）。 它首次出現在2000年Roy Fielding的博士論文中。

RESTful是一種定義Web API介面的設計風格，尤其適用於前後端分離的應用模式中。

這種風格的理念認為後端開發任務就是提供資料的，對外提供的是資料資源的訪問介面，所以在定義介面時，客戶端訪問的URL路徑就表示這種要操作的資料資源。

事實上，我們可以使用任何一個框架都可以實現符合restful規範的API介面。

1 資料的安全保障

  • url連結一般都採用https協議進行傳輸

注：採用https協議，可以提高資料互動過程中的安全性

2 介面特徵表現

  • 用api關鍵字標識介面url：

    • https://api.baidu.com
    • https://www.baidu.com/api
      注：看到api字眼，就代表該請求url連結是完成前後臺資料互動的

3 多資料版本共存

在url連結中標識資料版本

https://api.baidu.com/v1
https://api.baidu.com/v2
注：url連結中的v1、v2就是不同資料版本的體現（只有在一種資料資源有多版本情況下）

4 資料即是資源，均使用名詞（可複數）

  • 介面一般都是完成前後臺資料的互動，互動的資料我們稱之為資源

    • https://api.baidu.com/users
    • https://api.baidu.com/books
    • https://api.baidu.com/book
      注：一般提倡用資源的複數形式，在url連結中獎勵不要出現操作資源的動詞，錯誤示範：https://api.baidu.com/delete-user

  • 特殊的介面可以出現動詞，因為這些介面一般沒有一個明確的資源，或是動詞就是介面的核心含義

    • https://api.baidu.com/place/search
    • https://api.baidu.com/login

5 資源操作由請求方式決定（method）

操作資源一般都會涉及到增刪改查，我們提供請求方式來標識增刪改查動作
https://api.baidu.com/books - get請求：獲取所有書
https://api.baidu.com/books/1 - get請求：獲取主鍵為1的書
https://api.baidu.com/books - post請求：新增一本書書
https://api.baidu.com/books/1 - put請求：整體修改主鍵為1的書
https://api.baidu.com/books/1 - patch請求：區域性修改主鍵為1的書
https://api.baidu.com/books/1 - delete請求：刪除主鍵為1的書

6 過濾，透過在url上傳參的形式傳遞搜尋條件

  • https://api.example.com/v1/zoos?limit=10：指定返回記錄的數量
  • https://api.example.com/v1/zoos?offset=10：指定返回記錄的開始位置
  • https://api.example.com/v1/zoos?page=2&per_page=100：指定第幾頁，以及每頁的記錄數
  • https://api.example.com/v1/zoos?sortby=name&order=asc：指定返回結果按照哪個屬性排序，以及排序順序
  • https://api.example.com/v1/zoos?animal_type_id=1：指定篩選條件

錯誤處理，應返回錯誤資訊，error當做key

{
    error: "無許可權操作"
}

返回結果，針對不同操作，伺服器向使用者返回的結果應該符合以下規範

GET /collection：返回資源物件的列表（陣列）
GET /collection/resource：返回單個資源物件
POST /collection：返回新生成的資源物件
PUT /collection/resource：返回完整的資源物件
PATCH /collection/resource：返回完整的資源物件
DELETE /collection/resource：返回一個空文件
需要url請求的資源需要訪問資源的請求連結
# Hypermedia API，RESTful API最好做到Hypermedia，即返回結果中提供連結，連向其他API方法，使得使用者不查文件，也知道下一步應該做什麼
{
  	"status": 0,
  	"msg": "ok",
  	"results":[
        {
            "name":"肯德基(羅餐廳)",
            "img": "https://image.baidu.com/kfc/001.png"
        }
      	...
		]
}

比較好的介面返回

# 響應資料要有狀態碼、狀態資訊以及資料本身
{
  	"status": 0,
  	"msg": "ok",
  	"results":[
        {
            "name":"肯德基(羅餐廳)",
            "location":{
                "lat":31.415354,
                "lng":121.357339
            },
            "address":"月羅路2380號",
            "province":"上海市",
            "city":"上海市",
            "area":"寶山區",
            "street_id":"339ed41ae1d6dc320a5cb37c",
            "telephone":"(021)56761006",
            "detail":1,
            "uid":"339ed41ae1d6dc320a5cb37c"
        }
      	...
		]
}

RESTful 核心總結：

# 1.使用http協議進行傳輸資料
# 2.url 攜帶關鍵字api
	https://api.baidu.com
	https://www.baidu.com/api
# 3.url中帶版本資訊
	https://api.baidu.com/v1
	https://api.baidu.com/v2
# 4. 在url中有資料版本(v1版本，v2版本)
  https://api.baidu.com/users
  https://api.baidu.com/books
  https://api.baidu.com/book
# 5. 資料即資源，url均使用名詞
	查詢操作---get
        新增操作---post
        修改操作---put,patch
 	刪除操作---delete
# 6. 請求url中帶搜尋條件
https://api.example.com/v1/zoos?page=2&per_page=100：指定第幾頁，以及每頁的記錄數
https://api.example.com/v1/zoos?animal_type_id=1：指定篩選條件
# 7. 響應中要帶狀態碼
	公司會自定義狀態碼
  {
    status:200
  }
# 8. 響應返回錯誤資訊，錯誤處理
{
  status : 200,
  msg : '無許可權操作'
}
# 9. 返回結果，遵循如下規範。
  GET /collection：返回資源物件的列表（陣列）
  GET /collection/resource：返回單個資源物件
  POST /collection：返回新生成的資源物件
  PUT /collection/resource：返回完整的資源物件
  PATCH /collection/resource：返回完整的資源物件
  DELETE /collection/resource：返回一個空文件
# 10.返回資料中帶請求連線
# Hypermedia API，RESTful API最好做到Hypermedia，即返回結果中提供連結，連向其他API方法，使得使用者不查文件，也知道下一步應該做什麼
{
  	"status": 0,
  	"msg": "ok",
  	"results":[
        {
            "name":"肯德基(羅餐廳)",
            "img": "https://image.baidu.com/kfc/001.png"
        }
      	...
		]
}

相關文章