漫談Web API的設計-總結

1. API的概念

Application Programming Interface.應用編程接口，早期開發Win32或者MFC的程序員很是的熟悉。添加Web前綴以後，就變成了Web API。主要先後端開發過程當中，程序交互使用的接口。

2. Web API包含內容

1. 地址
2. 請求方式
3. 請求參數
4. 返回參數
5. 其餘

3. Web API的設計步驟

1. 肯定功能需求，根據頁面和自己業務邏輯設計相應的接口
2. 選擇承載技術。好比目前基於流行的RESTful風格，採用HTTP+JSON的方式居多。
3. 肯定接口風格。有遵循SOAP協議的web service風格，有基於HTTP+JSON的restful風格等。
4. 定義接口形式

4.1 條件查詢

/books/123 //查詢id爲123的圖書詳情信息
/books/123/price //查詢id爲123的圖像價格
複製代碼

4.2 消息正文封裝

{
    "name":"xxx",
    "companyId":"1001",
    "age":30,
    "address":{
        "city":"suzhou",
        "road":"kejicehng ..."
    }
}
複製代碼

• 傳遞惟一業務字段，好比name
• 傳遞惟一id，好比companyId，對於companyName是不須要前端傳入，後臺應該是有能力根據companyId獲取到對應的companyName。
• 傳遞關聯對象。傳入數據關聯了其餘對象數據。

4.3 響應和異常設計

實際開發中，常見響應和異常設計以下：

成功

{
    "message":"ok",
    "success":true,
    "entity":{
        //對象或者數組
    }
}
複製代碼

失敗

{
    "message":"新建用戶失敗",
    "success":false,
    "entity":null
}
複製代碼

更多

不少使用的API也經過聚合在市場上，經過次數計費。實際開發過程當中，咱們能夠直接購買付費的API，快速的開發咱們本身的業務。www.juhe.cn/