![](https://help.apple.com/assets/62867F4BA154561AD42D0C98/62867F4EA154561AD42D0CA7/zh_HK/389e356d55e928d40def9c16d476e5e0.png)
在 iPhone 或 iPad 的「捷徑」要求你的首個 API
如果要要求第一個 API,你需製作指向你想通訊的 API「端點」之 URL,然後傳送該 URL 給「取得 URL 內容」動作。捷徑執行時,此動作會發出 API 要求。
![包含指向 API 端點的 URL 動作之 API 請求,接著是「取得內容」的 URL 動作。](https://help.apple.com/assets/62867F4BA154561AD42D0C98/62867F4EA154561AD42D0CA7/zh_HK/71c9c13f3f038c925399833981900445.png)
建立 API 要求
Typicode 端點所需的 URL 要求格式如下:
https://jsonplaceholder.typicode.com/[RESOURCE]
括號內的文字是你要取用的資源。Typicode 提供多種不同的測試要求範例。此範例會使用 https://jsonplaceholder.typicode.com/users
來要求用户列表。
在你的 iOS 或 iPadOS 裝置的「捷徑」App 中,將要求加入到 URL。
用户
要求會返回用户列表。你可以按識別碼指定特定用户來收窄搜尋:
https://jsonplaceholder.typicode.com/users/6
。這樣會傳回識別碼是 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 簡介。