首頁 >後端開發 >php教程 >web API介面及restful規範詳解

web API介面及restful規範詳解

angryTom
angryTom原創
2019-11-28 14:47:515099瀏覽

web API介面及restful規範詳解

什麼是web API介面?

明確了請求方式,提供對應後台所需參數,請求url連結可以得到後台的回應資料

請求方式:get,post,put,patch. ...

請求參數:json或xml格式的key-value類型資料

回應結果:傳回json或xml格式的key-value類型資料

怎麼寫介面?

參考某種規則(規範)書寫url鏈接,同時根據規則制定請求方式,請求資料與回應結果

介面規範:webapi介面規範:restful

RESTful介紹

REST與技術無關,代表的是軟體架構風格,REST是Representational State Transfer的簡稱,中文翻譯為“表徵狀態轉移”或“表現層狀態轉換”。

網域

用api關鍵字來識別介面url

https://api.example.com
https://example.org/api/

註:看到api字眼,就代表該請求url連結是完成前後台資料互動的

版本

1. 將版本資訊放在URL中,如:

https://api.example.com/v1/
https://api.example.com/v2/

v1,v2代表不同資料版本的提現,前提是一種資料資源有多個版本

2. 將版本資訊放在請求頭中。

url路徑

視網路上任何東西都是資源,均使用名詞表示(一般為複數形式)

https://api.example.com/v1/zoos
https://api.example.com/v1/animals
https://api.example.com/v1/employees

在url連結中獎勵不要出現操作資源的動詞

錯誤示範:https://api.baidu.com/delete-user

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

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

method請求方式

GET :從伺服器取出資源(一項或多項)

POST :在伺服器新建一個資源

PUT :在伺服器更新資源(客戶端提供變更後的完整資源)

PATCH :在伺服器更新資源(客戶端提供改變的屬性)

DELETE :從伺服器刪除資源

過濾

透過在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:指定筛选条件

狀態碼

200 OK - [GET]:伺服器成功傳回使用者請求的數據,該操作是冪等的(Idempotent)。

201 CREATED - [POST/PUT/PATCH]:​​使用者新建或修改資料成功。

202 Accepted - [*]:表示一個請求已經進入後台排隊(非同步任務)

204 NO CONTENT - [DELETE]:使用者刪除資料成功。

301:永久重定向

302:暫時重定向

400 INVALID REQUEST - [POST/PUT/PATCH]:​​使用者發出的請求有錯誤,伺服器沒有進行新建或修改資料的操作,該操作是冪等的。

401 Unauthorized - [*]:表示使用者沒有權限(令牌、使用者名稱、密碼錯誤)。

403 Forbidden - [*] 表示使用者獲得授權(與401錯誤相對),但是存取是被禁止的。

404 NOT FOUND - [*]:使用者發出的請求針對的是不存在的記錄,伺服器沒有進行操作,該操作是冪等的。

406 Not Acceptable - [GET]:使用者請求的格式不可用(例如使用者請求JSON格式,但只有XML格式)。

410 Gone -[GET]:使用者請求的資源被永久刪除,且不會再得到的。

422 Unprocesable entity - [POST/PUT/PATCH] 當建立一個物件時,發生一個驗證錯誤。

500 INTERNAL SERVER ERROR - [*]:伺服器發生錯誤,使用者將無法判斷發出的請求是否成功。

錯誤處理

狀態碼是4xx時,應傳回錯誤訊息,error當做key。

{
    error: "Invalid API key"
}

傳回結果

針對不同操作,伺服器向使用者傳回的結果應該符合下列規格

GET     /collection:傳回資源物件的列表(陣列)

GET     /collection/resource:傳回單一資源物件

POST    /collection:傳回新產生的資源物件

PUT     /collection/resource:傳回完整的資源物件

PUT     /collection/resource:傳回完整的資源物件

PATCH   /collection/resource:傳回完整的資源物件

DELETE  /collection/resource:傳回一個空白文檔

{
    "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"
        }
        ...
        ]
}

Hypermedia API

RESTful API最好做到Hypermedia,即返回結果中提供鏈接,連向其他API方法,使得用戶不查文檔,也知道下一步該做什麼。

{"link": {
  "rel":   "collection https://www.example.com/zoos",
  "href":  "https://api.example.com/zoos",
  "title": "List of zoos",
  "type":  "application/vnd.yourformat+json"
}}
更多PHP相關知識,請造訪

PHP中文網###! ###

以上是web API介面及restful規範詳解的詳細內容。更多資訊請關注PHP中文網其他相關文章!

陳述:
本文內容由網友自願投稿,版權歸原作者所有。本站不承擔相應的法律責任。如發現涉嫌抄襲或侵權的內容,請聯絡admin@php.cn

相關文章

看更多