Сделать вызов API в VS Code очень просто, просто установите одно расширение, и тогда вам не придется полагаться на какие-либо внешние инструменты для выполнения работы.

Во время разработки вы обычно делаете запросы к API. Это может быть какой-то внешний API или API вашего собственного внутреннего сервера.

Вы можете использовать сторонние инструменты, такие как Postman, для выполнения вызовов API. Но расширение VS Code позволяет вам выполнять вызовы API прямо из VS Code. Здесь вы узнаете, как выполнять запросы API в VS Code.

Клиентское расширение VS Code REST

Расширение в VS Code — это подключаемый модуль или надстройка, расширяющая функциональные возможности редактора кода Visual Studio. Рынок расширений VS Code предоставляет несколько типов расширений, которые могут помочь вам в решении задач программирования. Есть расширение для добавления языковой поддержки. Есть один для обеспечения автозаполнения для определенного языка программирования и так далее. Расширения упрощают программирование с помощью VS Code..

instagram viewer

Расширение REST Client позволяет выполнять запросы API из VS Code. Расширение включает редактор REST API, визуальный интерфейс, который позволяет запрашивать конечные точки API. Он принимает пользовательские заголовки, параметры запроса и некоторые другие параметры.

Чтобы установить REST-клиент, откройте VS Code и щелкните значок Расширения вкладка Искать REST-клиент и нажмите на Установить кнопку, чтобы добавить его в VS Code.

Под Подробности на вкладке вы найдете полезный учебник о том, как использовать клиент для отправки запросов API. Давайте рассмотрим четыре распространенных типа запросов и способы их выполнения с помощью расширения клиента REST.

мы будем использовать JSONPlaceholder чтобы продемонстрировать выполнение вызовов API с использованием клиентского расширения REST. Он предоставляет шесть общих ресурсов, которые вы можете читать, редактировать, обновлять или удалять, отправляя запросы API.

Выполнение запроса GET с использованием клиентского расширения REST

Начните с создания .http файл для ваших запросов API. Вы можете назвать файл мои запросы.http.

Добавьте следующий код в свой мои запросы.http файл для получения ресурса из API JSONPlaceholder с идентификатором 1:

ПОЛУЧАТЬ https://jsonplaceholder.typicode.com/posts/1 HTTP/1.1

Чтобы отправить запрос, нажмите кнопку Послать запрос Кнопка, которая появляется в верхней части файла. Откроется новое окно, содержащее детали ответа.

Вот как вы делаете запрос GET внутри VS Code.

Выполнение запроса POST с использованием клиентского расширения REST

Вы делаете запрос POST, когда хотите отправить данные на сервер, обычно для создания нового ресурса.

Чтобы создать новый ресурс в JSONPlaceholder API, замените код в вашем мои запросы.http файл со следующим:

ПОЧТА https://jsonplaceholder.typicode.com/posts HTTP/1.1
Тип содержимого: "приложение/json"
{
 "название": "фу",
 "тело": "бар",
 "идентификатор пользователя": 1
}

Нажмите на Послать запрос кнопка отправки запроса. Опять же, это откроет новое окно, содержащее данные ответа. Ответ показывает HTTP/1.1 201 Создано сообщение и идентификатор сообщения вместе с другими данными, если вызов API прошел успешно.

{
 "идентификатор": "101"
}

Выполнение запроса PUT с использованием клиентского расширения REST

Вы делаете запрос PUT, когда хотите обновить данные на сервере.

Чтобы обновить существующий ресурс в JSONPlaceholder API, замените код в вашем мои запросы.http файл со следующим:

ПОМЕЩАТЬ https://jsonplaceholder.typicode.com/posts/1 HTTP/1.1
Тип содержимого: "приложение/json"
{
 "название": "новый фу",
 "тело": "новый бар",
 "идентификатор пользователя": 1
}

После отправки запроса ресурс будет обновлен на мок-сервере, и вы получите HTTP/1.1 200 ОК сообщение.

Выполнение запроса PATCH с использованием клиентского расширения REST

Вы делаете запрос PATCH, когда хотите изменить конкретное поле или свойство данного ресурса на сервере.

Чтобы обновить только заголовок существующего ресурса на фиктивном сервере, замените код в своем мои запросы.http файл со следующим:

https://jsonplaceholder.typicode.com/posts/1 HTTP/1.1 
Тип содержимого: "приложение/json"
{
 "title": "другой фу"
}

После того, как вы сделаете запрос, название ресурса будет обновлено на фиктивном сервере, и вы получите HTTP/1.1 200 ОК сообщение вместе с другими данными ресурса.

Выполнение запроса DELETE с использованием клиентского расширения REST

Вы делаете запрос DELETE, когда хотите удалить ресурс на сервере.

Чтобы удалить существующий ресурс на фиктивном сервере, замените код в вашем мои запросы.http файл со следующим:

УДАЛИТЬ https://jsonplaceholder.typicode.com/posts/1 HTTP/1.1

Здесь Тип содержимого не требуется, как и объект данных. Если вы отправите запрос и успешно удалите ресурс, вы должны получить HTTP/1.1 200 ОК ответ с пустым объектом.

Делайте вызовы API прямо из кода VS

Ранее вы могли использовать сторонние инструменты, такие как Почтальон для запросов к API. Хотя эти инструменты хорошо справляются со своей задачей, для их настройки требуется время. Например, вам нужно иметь учетную запись в Postman, чтобы использовать проводник API.

Хотя есть несколько онлайн-инструментов для тестирования API, но с такими расширениями, как клиент REST, тестирование API становится намного быстрее и проще. Вы можете протестировать любой API прямо из редактора VS Code. Это особенно полезно, если вы разрабатываете API локально и хотите протестировать свои локальные API на лету.

Другие расширения API для тестирования VS Code

Rest Client прост в использовании. Но это не единственное расширение VS Code для тестирования API. Другими популярными вариантами являются Thunder Client, httpYak и httpBook.

Thunder Client предоставляет визуальный редактор API для упрощения запросов API. Конечно, вам нужно знать, что такое REST API, чтобы использовать эти инструменты.