1、什么是web API接口
url:https://api.map.baidu.com/place/v2/search
"""
接口概念:前台與后台進行信息交互的媒介 - url鏈接
接口組成:四大特點
url鏈接 - 長得像返回數據的url鏈接
請求方式 - get(查)、post(增)、put(整體改)、patch(局部改)、delete(刪)
請求參數 - 拼接參數、數據包參數(urlencoded、form-data、json)
響應結果 - 響應的json數據
"""
2、YApi
YApi是去哪兒網的一個開源可視化的接口管理平台
YApi項目可以搭建在任何本地或者雲服務器上,完成后態項目開發時的接口編寫。為開發、測試人員提供可視化的接口預覽。同時提供了測試網站:http://yapi.demo.qunar.com/ ,我們可以先通過測試網站
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格式的數據
3、開發階段接口測試工具
"""
Postman:
官網下載、傻瓜式安裝
"""
4、接口文檔
"""
1)為什么要寫接口文檔
為什么要寫接口:作為后台開發者,要將后台數據通過url鏈接反饋給前台
為什么要寫文檔:作為后台開發者,一定知道改url鏈接應該采用什么請求方式、提交哪些數據、返回了哪些結果
就像后台要將url鏈接改前台一樣,前台知道應該訪問什么鏈接,所以前台也應該知道采用什么請求方式,以及提交什么數據。
換而言之,接口文檔是給 后台開發者、前台開發者、測試等各個項目相關項目組同時查看的,方便團隊開發(規則是后台指定的,文檔后台來寫)
2)編寫文檔
i)采用word編寫
ii)drf框架有插件,可以根據cbv的類快速生成文檔
iii)采用寫文檔的平台
3)書寫過程
i)先安裝開發需要,完成接口的開發(設置后台url鏈接,設置請求方式、請求數據、響應結果)
ii)選擇一個接口平台,將后台url鏈接,設置請求方式、請求數據、響應結果信息變成成文檔即可
"""
5、接口規范
"""
1)為什么要指定接口規范
在前后台分離情況下,后台可以采用不同的后台運用,開發出類似的功能,所以前后台請求響應的規則是一致的;如果安裝一套標准來編寫接口,后台不管是什么語言,前台都可以采用一樣的方式進行交互。反過來,后台也不需要管前台到底采用何種方式請求(頁面、工具、代碼)
2)通用的接口規范:Restful接口規范 - 規定了url如何編寫;請求方式的含義;響應的數據規則
i)url編寫
https協議 - 保證數據安全性
api字眼 - 標識操作的是數據
v1、v2字眼 - 數據的不同版本共存
資源復數 - 請求的數據稱之為資源
拼接條件 - 過濾群查接口數據(https://api.baidu.com/books/?limit=3&ordering=-price)
ii)請求方式
/books/ - get - 群查
/books/(pk)/ - get - 單查
/books/ - post - 單增
/books/(pk)/ - put - 單整體改
/books/(pk)/ - patch - 單局部改
/books/(pk)/ - delete - 單刪
iii)響應結果
網絡狀態碼與狀態信息:2xx | 3xx | 4xx | 5xx
數據狀態碼:前后台約定規則 - 0:成功 1:失敗 2:成功無結果
數據狀態信息:自定義成功失敗的信息解釋(英文)
數據本體:json數據
數據子資源:頭像、視頻等,用資源的url鏈接
"""