1. 程式人生 > >初識web API介面及Restful介面規範

初識web API介面及Restful介面規範

一、web API介面

什麼是web API介面?:

明確了請求方式,提供對應後臺所需引數,請求url連結可以得到後臺的響應資料
url : 返回資料的url
https://api.map.baidu.com/place/search
請求方式:
get,post,put,patch....

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

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

響應結果:
​ 返回json或xml格式的key-value型別資料

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

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

怎麼寫介面?:

​ 參照某種規則(規範)書寫url連結,同時根據規則制定請求方式,請求資料與響應結果

介面文件:

​ 提供給前後臺開發人員與測試人員檢視

介面工具:

YAPI平臺

​ 專門寫介面文件的YAPI平臺 http://yapi.demo.qunar.com/

​ YApi是去哪兒網的前端技術中心的一個開源視覺化介面管理平臺。

  • 建立介面專案

  • 建立介面

  • 編寫介面

介面測試工具:Postman

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

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

  • 工作面板

  • 簡易的get請求

  • 簡易的post請求

  • 案例:請求百度地圖介面

介面規範:

​ webapi介面規範:restful

RESTful API介紹

RESTful介紹

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

推薦閱讀 阮一峰 理解RESTful架構

RESTful API設計指南

推薦閱讀 阮一峰 RESTful設計指南

API與使用者的通訊協議

總是使用HTTPs協議。

域名

用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:返回完整的資源物件
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"
}}