Poznaj swoje IDE – PHPStorm #1: Rest Client

Chciałbym zapoczątkować cykl krótszych wpisów opisujących pewne funkcje IDE o których nie wszyscy wiedzą, a przydają się w codziennej pracy programisty. W większości będą opierały się o PHPStorm, ponieważ w nim spędzam większość swojego dnia. Nie przedłużając, przejdźmy do konkretów.

Większość developerów do testowania API RESTowego używa Postman’a, jednak nie każdy wie, że narzędzie o podobnych właściwościach zaszyte jest w samym PHPStormie, dzięki czemu nie musimy opuszczać IDE aby przetestować daną funkcjonalność.

Aby uruchomić narzędzie do testowania API musimy z menu wybrać Tools -> Test RESTful Web Service

Po otwarciu ukazuje nam się osobne okno aplikacji.

PHPStorm RESTFull Client

Do dyspozycji mamy wszystkie standardowe metody requestu do API.

PHPStorm RESTFull Client

Następnie musimy w polu Host/port podać adres strony z/bez portu, oraz w polu Path uzupełnić ścieżkę endpointu. Istnieje możliwość bezproblemowego przeklejenia url z przeglądarki, wystarczy wkleić go w pole Host/port aby PHPStorm sam rozdzielił host i ściężkę.

Odpalenie requesta odbywa się tradycyjnie zielony przycisk play bądź skrót klawiszowy ⌘Enter.

W zakładce Request posiadamy trzy panele, Headers, Request Parameters, Request Body.

W Headers umieszczamy wszystkie parametry jakie chcemy wysłać w nagłówkach, zdefiniować możemy format wchodzących parametrów wejściowych (pole accept), format odpowiedzi (pole content-type), mechanizm cache’owania (pole cache-control) itp.

Dodanie i usuwanie nagłówków wykonujemy przez + i umieszczony w lewym dolnym rogu panelu.

PHPStorm RESTFull Client

W panelu Request Parameters umieszczamy wszystkie parametry które musimy przekazać do serwera. Standardowo niczego nie ma, jednak wystarczy dodać parametry w formie klucz wartość i możemy je wysłać jako parametry.

Ostatnim panelem jest Request Body który jest nieaktywny przy następujących metodach: GET, DELETE, HEAD oraz OPTIONS. W tym panelu możemy ustawiać jaki typ body ma zostać wysłany, standardowo zaznaczona jest opcja Empty. Wybierając Text możemy wysłać stringa z parametrami wewnątrz (np. JSON). File Contents służy do wysłania pliku na serwer, File upload (multipart/form-data) służy do wysłania binarnego pliku jako parametru.

Kolejna ciekawa zakładka to Cookies.

W niej możemy tworzyć, zapisywać edytować oraz usuwać ciasteczka czy to stworzone manualnie czy otrzymane w odpowiedzi.

PHPStorm RESTFull Client

PHPStorm RESTFull Client

Wartości jakie trzeba uzupełnić wydają mi się, wystarczająco jednoznaczne, że nie trzeba ich dodatkowo opisywać 😉

W zakładce Response otrzymujemy odpowiedź z serwera. Którą możemy otworzyć w przeglądarce, otworzyć jako tekst, wyświetlić jako HTML, XML oraz JSON.

PHPStorm RESTFull Client

Ostatnią zakładką jest Response Header w której otrzymujemy nagłówki z odpowiedzi z serwera.

PHPStorm Response REST Client

Poniżej działanie klienta na testowym API.

Jak widzimy na powyższym przykładzie funkcjonalność klienta REST w PHPStormie jest wystarczająca do większości jak nie wszystkich zastosowań. Osobiście do testowania API używam już tylko PHPStorma. Dla mnie największą zaletą jest fakt, że nie muszę przełączać się pomiędzy wirtualnymi ekranami/fizycznymi aby przetestować daną funkcjonalność. Dodatkowo przydatne jest posiadanie wszystkiego w jednym miejscu z możliwością podglądu kodu na bierząco z działaniem na API.

 

Dodaj komentarz