Как да правите REST API извиквания от вътре VS код

По време на разработката е обичайно да правите заявки към API. Това може да е към някакъв външен API или API на вашия собствен бекенд сървър.

Можете да използвате инструменти на трети страни като Postman, за да извършвате вашите API повиквания. Но разширението на VS Code ви позволява да правите API извиквания направо от VS Code. Тук ще научите как да изпълнявате API заявки във VS Code.

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

Разширението във VS Code е плъгин или добавка, която подобрява функционалностите на редактора на Visual Studio Code. Пазарът за разширения на VS Code предоставя няколко вида разширения, които могат да ви помогнат с вашите задачи по програмиране. Има разширение за добавяне на езикова поддръжка. Има един за осигуряване на автоматично попълване за конкретен език за програмиране и т.н. Разширенията улесняват програмирането с VS Code.

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

За да инсталирате REST клиент, отворете VS Code и щракнете върху Разширения раздел. Търся REST клиент и щракнете върху Инсталирай бутон, за да го добавите към VS Code.

Под Подробности раздел, ще намерите полезен урок за това как да използвате клиента, за да правите заявки за API. Нека видим четирите често срещани типа заявки и как да ги направите с помощта на разширението REST Client.

Ние ще използваме JSON Placeholder за да демонстрирате извършване на API извиквания с помощта на разширението REST Client. Той предоставя шест общи ресурса, които можете да четете, редактирате, актуализирате или изтривате, като правите заявки за API.

Извършване на GET заявка с помощта на клиентското разширение REST

Започнете със създаване на a .http файл за вашите API заявки. Можете да дадете име на файла myrequests.http.

Добавете следния код към вашия myrequests.http файл за извличане на ресурс от JSONPlaceholder API с 1 като ID:

ВЗЕМЕТЕ https://jsonplaceholder.typicode.com/posts/1 HTTP/1.1

За да изпратите заявката, щракнете върху Изпрати заявка бутон, който се появява в горната част на файла. Ще се отвори нов прозорец, който съдържа подробности за отговора.

Ето как правите GET заявка във VS Code.

Извършване на POST заявка с помощта на клиентското разширение REST

Правите POST заявка, когато искате да публикувате данни към сървъра, обикновено за създаване на нов ресурс.

За да създадете нов ресурс в JSONPlaceholder API, заменете кода във вашия myrequests.http файл със следното:

ПУБЛИКУВАНЕ https://jsonplaceholder.typicode.com/posts HTTP/1.1
Тип съдържание: "приложение/json"
{
 "заглавие": "фу",
 "тяло": "лента",
 "userId": 1
}

Щракнете върху Изпрати заявка бутон за изпращане на заявката. Отново това ще отвори нов прозорец, съдържащ данните за отговора. Отговорът показва HTTP/1.1 201 Създаден съобщение и ID на публикацията заедно с други данни, ако извикването на API е успешно.

{
 "id": "101"
}

Извършване на PUT заявка с помощта на клиентското разширение REST

Вие правите PUT заявка, когато искате да актуализирате данни на сървъра.

За да актуализирате съществуващ ресурс в JSONPlaceholder API, заменете кода във вашия myrequests.http файл със следното:

СЛАГАМ https://jsonplaceholder.typicode.com/posts/1 HTTP/1.1
Тип съдържание: "приложение/json"
{
 "title": "нов foo",
 "body": "нова лента",
 "userId": 1
}

След като изпратите заявката, ресурсът ще бъде актуализиран на макетния сървър и ще получите HTTP/1.1 200 OK съобщение.

Извършване на заявка за PATCH с помощта на клиентското разширение REST

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

За да актуализирате само заглавието на съществуващ ресурс в макетния сървър, заменете кода във вашия myrequests.http файл със следното:

https://jsonplaceholder.typicode.com/posts/1 HTTP/1.1 
Тип съдържание: "приложение/json"
{
 "заглавие": "още едно глупаво"
}

След като направите заявката, заглавието на ресурса ще бъде актуализирано на макетния сървър и ще получите HTTP/1.1 200 OK съобщение заедно с другите данни на ресурса.

Извършване на заявка за ИЗТРИВАНЕ с помощта на клиентското разширение REST

Правите DELETE заявка, когато искате да изтриете ресурс на сървъра.

За да изтриете съществуващ ресурс в макетния сървър, заменете кода във вашия myrequests.http файл със следното:

ИЗТРИЙ https://jsonplaceholder.typicode.com/posts/1 HTTP/1.1

Ето, Тип съдържание не се изисква, както и обектът на данни. Ако изпратите заявката и успешно изтриете ресурса, трябва да получите HTTP/1.1 200 OK отговор с празен обект.

Правете API извиквания направо от VS кода

Преди това може да сте използвали инструменти на трети страни като Пощальон, който да прави API заявки. Въпреки че тези инструменти вършат работата добре, настройката им отнема време. Например, трябва да имате акаунт в Postman, за да използвате API Explorer.

Въпреки че има няколко онлайн инструмента за тестване на API, но с разширения като REST Client, тестването на API е много по-бързо и лесно. Можете да тествате всеки API направо от вашия VS Code редактор. Това е особено полезно, ако разработвате локално API и искате да тествате локалните си API в движение.

Други API тестване срещу разширения на код

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

Thunder Client предоставя визуален API редактор за опростяване на API заявките. Разбира се, трябва да знаете какво е REST API, за да използвате тези инструменти.