nodejs學習07——API

接口

一、簡介

1.1 接口是什麼

接口是 前後端通信的橋樑
簡單理解：一個接口就是 服務中的一個路由規則 ，根據請求響應結果
接口的英文單詞是 API (Application Program Interface)，所以有時也稱之爲 API 接口
這裏的接口指的是『數據接口』， 與編程語言（Java，Go 等）中的接口語法不同

1.2 接口的作用

實現 前後端通信

1.3 接口的開發與調用

大多數接口都是由 後端工程師 開發的， 開發語言不限
一般情況下接口都是由 前端工程師 調用的，但有時 後端工程師也會調用接口 ，比如短信接口，支付接口 等

1.4 接口的組成

一個接口一般由如下幾個部分組成
請求方法
接口地址（URL）
請求參數
響應結果
一個接口示例 https://www.free-api.com/doc/325

體驗一下： https://api.asilu.com/idcard/?id=371522199111299668

二、RESTful API

RESTful API 是一種特殊風格的接口，主要特點有如下幾個：

• URL 中的路徑表示 資源 ，路徑中不能有 動詞 ，例如 create , delete , update 等這些都不能有
• 操作資源要與 HTTP 請求方法 對應
• 操作結果要與 HTTP 響應狀態碼 對應
  規則示例：

操作	請求類型	URL	返回
新增歌曲	POST	/song	返回新生成的歌曲信息
刪除歌曲	DELETE	/song/10	返回一個空文檔
修改歌曲	PUT	/song/10	返回更新後的歌曲信息
修改歌曲	PATCH	/song/10	返回更新後的歌曲信息
獲取所有歌曲	GET	/song	返回歌曲列表數組
獲取單個歌曲	GET	/song/10	返回單個歌曲信息

擴展閱讀： https://www.ruanyifeng.com/blog/2014/05/restful_api.html

三、json-server

json-server 本身是一個 JS 編寫的工具包，可以快速搭建 RESTful API 服務
官方地址: https://github.com/typicode/json-server
操作步驟：

1. 全局安裝 json-server
   npm i -g json-server
   我的node版本低，用的
   npm i -g [email protected]
2. 創建 JSON 文件（db.json），編寫基本結構

{
	"song": [
		{ "id": 1, "name": "乾杯", "singer": "五月天" },
		{ "id": 2, "name": "當", "singer": "動力火車" },
		{ "id": 3, "name": "不能說的祕密", "singer": "周杰倫" }
	]
}

3. 以 JSON 文件所在文件夾作爲工作目錄 ，執行如下命令
   json-server --watch db.json
   默認監聽端口爲 3000

若報錯：json-server : 無法加載文件 ...\npm\json-server.ps1，因爲在此係統上禁止運行腳本。
解決：以管理員身份運行powershell（快捷鍵：windows+X）
輸入如下指令：
set-executionpolicy remotesigned
輸入Y
參考：https://blog.csdn.net/qq_42829970/article/details/117259381

四、接口測試工具

介紹幾個接口測試工具
apipost https://www.apipost.cn/ (中文)
apifox https://www.apifox.cn/ (中文)
postman https://www.postman.com/ (英文)