1）API 文檔的結(jié)構(gòu)

API 文檔通常分為幾個部分。每個部分都是一個可以使用 API 獲取的數(shù)據(jù)表。

例如，查看Poke API 文檔，您可以看到有名為 Berries、Contests、Encounters、Evolution 等的表組……

在每個表組中，都有一個可以使用 Poke API 獲取的表列表。這些表稱為 API 資源。例如，在 Pokemon 組中，有一個 Pokemon 表，其中列出了所有 Pokemon。

因此，使用 API 文檔，我們將知道可以使用此 API 獲取哪些表/資源。

2）從 Pokemon 表獲取數(shù)據(jù)

2.1）API請求工具

要使用 API，我們需要一個工具來發(fā)出 API 請求。最流行的工具是：

Postman：一個主要用于測試 API 請求的 Web 應(yīng)用程序 / 桌面應(yīng)用程序
CURL：一個命令行工具
一種編程語言（例如 Python）

我將在本演示中使用 Postman。您可以在http://postman.com上使用 Postman 的網(wǎng)頁版本。使用您的 Google 帳戶登錄，如果這是您第一次使用 Postman，請創(chuàng)建個人資料，然后您就可以開始了。登錄后，您將看到下面視頻中的屏幕。單擊“新建”>“HTTP 請求”開始發(fā)出 API 請求。

2.2）檢測發(fā)出 API 請求所需的輸入

你需要：

要發(fā)出 API 請求，您至少需要 3 個輸入：

端點：數(shù)據(jù)表的 URL
方法：與端點使用的交互方法
授權(quán)：針對API系統(tǒng)的授權(quán)方式。

當(dāng)您查看Pokemon 表時，您將看到有關(guān)端點和方法的以下信息：

在圖片中，你可以看到方法是GET。端點是https://pokeapi.co/api/v2/pokemon

后半部分{id or name}，稱為路徑參數(shù)。路徑參數(shù)可以是必需的，也可以是可選的。對于 Poke API，它是可選的。你怎么知道的？它在資源列表/分頁部分中提到。（調(diào)用任何沒有資源 ID 或名稱的 API 端點將……）

我們需要的最后一個輸入是授權(quán)。像這樣的公共 API 意味著任何人都可以在未經(jīng)授權(quán)的情況下使用它。因此授權(quán)方法是 No Auth。

總而言之，以下是我們將用來從 Pokemon 表中獲取數(shù)據(jù)的輸入：

端點：https://pokeapi.co/api/v2/pokemon
方法：GET
授權(quán)：無授權(quán)

2.3）將輸入導(dǎo)入 Postman

在 Postman 新建的無標(biāo)題請求中，輸入端點并選擇 GET 方法

切換到“授權(quán)”選項卡并確保選擇“無授權(quán)”（請參閱術(shù)語部分中的更多授權(quán)類型）

點擊發(fā)送按鈕發(fā)送 API 請求。當(dāng)狀態(tài)代碼返回 200 OK 時，表示您已發(fā)出正確的 API 請求，并且已返回數(shù)據(jù)。請參閱狀態(tài)代碼術(shù)語部分以了解有關(guān)常見狀態(tài)代碼的更多信息。

2.4）高級——路徑參數(shù)

路徑參數(shù)定義在3.2.2 節(jié)中提到。路徑參數(shù)通常用于獲取單個對象的詳細(xì)信息。

例如，您想要獲取有關(guān)特定 Pokemon（如 Pikachu）的詳細(xì)信息。您可以使用“pikachu”作為路徑參數(shù)并插入到端點中。

要查看有關(guān)皮卡丘的具體詳細(xì)信息，我們的 API 請求的輸入是：

端點：https://pokeapi.co/api/v2/pokemon/pikachu
方法：GET
授權(quán)：無授權(quán)

讓我們在 Postman 中編輯端點并點擊發(fā)送

返回的數(shù)據(jù)是有關(guān)皮卡丘的詳細(xì)信息。因此，使用路徑參數(shù)，您已檢索有關(guān)皮卡丘的數(shù)據(jù)。

2.5）高級——查詢參數(shù)

API 可以提供一種方法來過濾、排序和限制返回的數(shù)據(jù)。該方法通常是通過查詢參數(shù)來實現(xiàn)的。有些文檔將查詢參數(shù)僅稱為參數(shù)。因此，很容易將查詢參數(shù)與路徑參數(shù)混淆。

對于 Poke API，只有幾個查詢參數(shù)。其中一個允許 API 請求限制返回的記錄數(shù)。它在資源列表/分頁部分中描述。

根據(jù)描述，您可以添加一個名為“l(fā)imit”的查詢參數(shù)和我們想要的記錄數(shù)，API 將僅返回指定數(shù)量的記錄。例如，您想獲取 Pokemon 表上的前 2 個 pokemon。那么我們的 API 請求的輸入將是：

端點：https://pokeapi.co/api/v2/pokemon
方法：GET
授權(quán)：無授權(quán)
查詢參數(shù)：limit : 2

在 Postman 的 Params 選項卡中輸入查詢參數(shù)。Postman 會自動將這些參數(shù)輸入到 Endpoint 中。點擊發(fā)送。

如果您不使用查詢參數(shù)，返回的數(shù)據(jù)將僅顯示 2 個神奇寶貝，而不是 20 個。您已成功限制返回的數(shù)據(jù)。

下一步該去哪兒？

如果您已按照上述說明操作，那么恭喜您，您知道如何使用 GET 方法發(fā)出 API 請求。接下來，您可以練習(xí)：

POST 方法
術(shù)語部分列出的其他類型的授權(quán)。

術(shù)語

Host：調(diào)用 API 的服務(wù)器地址。可以是 IP 地址，也可以是網(wǎng)絡(luò)域名。示例 1：https://pokeapi.co/api/v2；示例 2：https://192.168.11.1
Resource：API Endpoint 中 Host 后面的部分，用于指向數(shù)據(jù)表。例如：pokemon
Path 參數(shù): API Endpoint 中 Resource 后面的部分，用于指向數(shù)據(jù)表中的具體對象。例如：pikachu
Endpoint：發(fā)送 API 請求的完整地址。Endpoint = Host + Resource + Path 參數(shù)。例如：https://pokeapi.co/api/v2/pokemon/pikachu
方法：使用 API 進行交互的方式。兩種最常見的方法是 GET 和 POST。GET 主要用于提取軟件上的數(shù)據(jù)。POST 主要用于編輯/創(chuàng)建新的軟件數(shù)據(jù)
查詢參數(shù)：提供一種過濾/排序/限制數(shù)據(jù)的方法。以鍵值形式輸入查詢參數(shù)。