![](https://help.apple.com/assets/62867F4BA154561AD42D0C98/62867F4EA154561AD42D0CA7/zh_CN/389e356d55e928d40def9c16d476e5e0.png)
在 iPhone 或 iPad 上的“快捷指令”中提出第一个 API 请求
若要提出第一个 API 请求,请创建指向要对话的 API “端点”的 URL,然后将 URL 传递给“获取 URL 内容”操作。快捷指令运行时,此操作会提出 API 请求。
![一条 API 请求,其中包含指向 API 端点的 URL 操作,接着是“获取 URL 内容”操作。](https://help.apple.com/assets/62867F4BA154561AD42D0C98/62867F4EA154561AD42D0CA7/zh_CN/b5469dd8d492c46e9b32d5b846feee6c.png)
构建 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 Object Notation)编码。
若要了解使用 JSON 的信息以及继续了解 Typicode API 示例,请参阅在 iPhone 和 iPad 上的“快捷指令”中使用 JSON 的介绍。