Выполнение первого запроса к API в Быстрых командах на Mac
Чтобы выполнить свой первый запрос к API, Вам потребуется создать URL-адрес, указывающий на «конечную точку» API, с которой Вы хотите установить связь. Затем необходимо передать этот URL-адрес действию «Получить содержимое URL». Данное действие совершает запрос к API во время выполнения быстрой команды.
Создание запроса к API
Конечная точка Typicode API требует, чтобы URL-запрос имел следующий формат:
https://jsonplaceholder.typicode.com/[РЕСУРС]
Вместо текста в скобках введите название ресурса, к которому хотите получить доступ. Typicode предлагает множество примеров для тестирования результатов. В этом примере для запроса списка пользователей используется https://jsonplaceholder.typicode.com/users.
В приложении «Быстрые команды»
на Mac добавьте запрос в URL‑адрес.Запрос
usersвернет список пользователей.Можно уточнить критерии поиска, например, указав идентификатор пользователя:
https://jsonplaceholder.typicode.com/users/6. Результат вернет пользователя с идентификатором 6.Большинство API позволяют выполнять запросы следующего формата:
https://jsonplaceholder.typicode.com/users?username=Bret. Знак вопроса («?») предваряет запрос, используемый для поиска объектов с помощью пар «ключ-значение». В этом примере запрос?username=Bretиспользуется для поиска пользователя по имени Bret.Обратитесь к документации API, чтобы узнать, какие поисковые и другие запросы он поддерживает.
Выполнение запроса к API с помощью действия «Получить содержимое URL»
В приложении «Быстрые команды»
на Mac нажмите «Показать больше» в действии «Получить содержимое URL».Отобразятся следующие доступные типы запросов к API:
Запрос
GETпозволяет получать данные.POST. Этот тип запроса позволяет создать новые данные.Запрос
PUTпозволяет обновлять данные посредством их замены.Запрос
PATCHпозволяет обновлять данные посредством их изменения.DELETE. Данный запрос позволяет удалить объект, указанный в URL запроса.
В этом примере используйте запрос
GETдля получения данных от Typicode API.Теперь, когда действие «URL-адрес» содержит Ваш запрос, а действие «Получить содержимое URL» настроено для получения данных с помощью
GET, Вы можете выполнить запрос к API.Примечание. Когда действие «Получить содержимое URL» настроено для типов запросов
POST,PUTилиPATCH, добавляется дополнительный параметр «Тело запроса». Параметр «Тело запроса» делает возможной отправку в составе Вашего запроса к API таких типов данных, как JSON, форма или файл. Это позволяет Вам вводить новые данные вручную или добавлять их с помощью переменных, чтобы затем отправлять их в запросе к API для создания, замещения или правки объекта данных.Чтобы протестировать быструю команду, нажмите
.На первый взгляд может показаться, что API вернул нечитаемый текст. Данные кодированы в JSON; эта аббревиатура расшифровывается как JavaScript Object Notation.
Чтобы узнать о том, как работать с JSON, и продолжить рассмотрение примера Typicode API, см. раздел Использование JSON в приложении «Быстрые команды» на Mac.