在 iPhone 或 iPad 上的「捷徑」中要求第一個 API
若要要求第一個 API,你製作指向你想通訊的 API「端點」之 URL,然後傳送該 URL 給「取得 URL 內容」動作。捷徑執行時,此動作會發出 API 要求。
建立 API 要求
Typicode 的端點所需的 URL 要求格式如下:
https://jsonplaceholder.typicode.com/[RESOURCE]
括號中的文字為你想取用的資源。Typicode 提供許多用於測試要求的不同範例。本範例使用 https://jsonplaceholder.typicode.com/users
來要求使用者列表。
在 iOS 或 iPadOS 裝置上的「捷徑」App 中,將要求加入 URL。
users
要求會傳回使用者列表。你可以依照 ID 指定特定使用者來縮小搜尋範圍:
https://jsonplaceholder.typicode.com/users/6
。這會傳回 ID 為 6 的使用者。大部分 API 都允許查詢使用下列格式:
https://jsonplaceholder.typicode.com/users?username=Bret
。「?」為查詢的開頭,該查詢使用鍵值對來搜尋項目。在此範例中,?username=Bret
會搜尋使用者名稱為 Bret 的使用者。請查看 API 的文件以了解支援的搜尋和查詢。
使用「取得 URL 內容」動作執行 API 要求
在 iOS 或 iPadOS 裝置上的「捷徑」App 中,在「取得 URL 內容」動作中點一下「顯示更多」。
以下你可發出的 API 要求類型選項會變為可用:
GET
可用來擷取資料。POST
可用來製作新資料。PUT
可用來藉由取代資料的方式來更新資料。PATCH
可用來藉由修改資料的方式來更新資料。DELETE
可用來移除 URL 要求中指定的物件。
在此範例中,使用
GET
要求來從 Typicode API 擷取資料。現在 URL 動作已具有你的要求,且「取得 URL 內容」動作已設為
GET
資料,表示你已準備好發出 API 要求。【注意】當「取得 URL 內容」動作切換為
POST
、PUT
或PATCH
時,會加入新參數「要求內文」。「要求內文」可用來將 JSON、表單或檔案做為要求的一部分傳送至 API。這讓你可手動或使用變數輸入新資料,因此可傳送資料至 API 以製作、取代或修改項目。若要測試捷徑,請點一下 。
看第一眼時,API 似乎傳回了雜亂無章的文字。此資料是以 JSON(全名為 JavaScript 物件標記法)編碼。
如需瞭解如何使用 JSON 和繼續操作 Typicode API 範例,請參閱:iPhone 和 iPad 上「捷徑」中的使用 JSON 簡介。