1)API 文檔的結構

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

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

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

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

2)從 Pokemon 表獲取數據

2.1)API請求工具

要使用 API,我們需要一個工具來發出 API 請求。最流行的工具是:

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

2.2)檢測發出 API 請求所需的輸入

你需要:

要發出 API 請求,您至少需要 3 個輸入:

當您查看Pokemon 表時,您將看到有關端點和方法的以下信息:

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

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

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

總而言之,以下是我們將用來從 Pokemon 表中獲取數據的輸入:

2.3)將輸入導入 Postman

在 Postman 新建的無標題請求中,輸入端點并選擇 GET 方法

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

點擊發送按鈕發送 API 請求。當狀態代碼返回 200 OK 時,表示您已發出正確的 API 請求,并且已返回數據。請參閱狀態代碼術語部分以了解有關常見狀態代碼的更多信息。

2.4)高級——路徑參數

路徑參數定義在3.2.2 節中提到。路徑參數通常用于獲取單個對象的詳細信息。

例如,您想要獲取有關特定 Pokemon(如 Pikachu)的詳細信息。您可以使用“pikachu”作為路徑參數并插入到端點中。

要查看有關皮卡丘的具體詳細信息,我們的 API 請求的輸入是:

讓我們在 Postman 中編輯端點并點擊發送

返回的數據是有關皮卡丘的詳細信息。因此,使用路徑參數,您已檢索有關皮卡丘的數據。

2.5)高級——查詢參數

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

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

根據描述,您可以添加一個名為“limit”的查詢參數和我們想要的記錄數,API 將僅返回指定數量的記錄。例如,您想獲取 Pokemon 表上的前 2 個 pokemon。那么我們的 API 請求的輸入將是:

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

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

下一步該去哪兒?

如果您已按照上述說明操作,那么恭喜您,您知道如何使用 GET 方法發出 API 請求。接下來,您可以練習:

術語

授權:某些 API 可能需要登錄/訪問令牌才能發出 API 請求。這稱為授權。授權的一些形式包括:

狀態代碼:一個 3 位數字,用于指示請求結果。最常見的狀態代碼是:

原文鏈接:https://medium.com/refined-and-refactored/how-to-make-basic-api-requests-with-postman-33ce912876ad

上一篇:

在 Spring Boot 中構建 API 響應的最佳方法

下一篇:

Java API 最佳實踐
#你可能也喜歡這些API文章!

我們有何不同?

API服務商零注冊

多API并行試用

數據驅動選型,提升決策效率

查看全部API→
??

熱門場景實測,選對API

#AI文本生成大模型API

對比大模型API的內容創意新穎性、情感共鳴力、商業轉化潛力

25個渠道
一鍵對比試用API 限時免費

#AI深度推理大模型API

對比大模型API的邏輯推理準確性、分析深度、可視化建議合理性

10個渠道
一鍵對比試用API 限時免費