Przejdź do głównej zawartości

Szybki start (5 minut)

Cel: wyjść od świeżej instalacji i dojść do uwierzytelnionego żądania, którego adres URL i token pochodzą ze zmiennych. Zajmuje to pięć minut.

Plik ▸ Nowy (Ctrl+N), następnie Plik ▸ Zapisz jako (Ctrl+Shift+S), aby nadać projektowi nazwę, na przykład demo.restorm.

Projekt jest zwykłym plikiem na dysku. Można go od razu umieścić w repozytorium git — Restorm jest do tego stworzony.

Kliknięcie prawym przyciskiem w drzewie w panelu bocznym ▸ Dodaj ▸ Folder zmiennych.

Folder zmiennych (nazywany też folderem środowisk) to kontener, który przechowuje środowiska — local, staging, production — a więc i {{variables}}. Wszystkie zawarte w nim żądania dziedziczą wybrane środowisko.

Po jego otwarciu należy utworzyć środowisko local i dodać w nim zmienną:

KluczTypWartość
baseUrlCiąg znakówhttps://api.exemple.test

Zakładka folderu zmiennych na podzakładce Środowiska: wybrane środowisko po lewej i jego zmienna baseUrl po prawej

Kliknięcie prawym przyciskiem na folderze ▸ Dodaj ▸ Żądanie HTTP. W otwartej zakładce należy:

  • pozostawić metodę GET;
  • wpisać adres URL {{baseUrl}}/health — rozwiązana wartość pojawia się pod polem i stanowi siatkę bezpieczeństwa;
  • kliknąć Send.

Odpowiedź otwiera się poniżej: status, czas, rozmiar, nagłówki oraz treść wyrenderowana w zwijanej przeglądarce JSON.

Żądanie HTTP, którego adres URL wykorzystuje {{baseUrl}}, z panelem odpowiedzi otwartym po prawej — status, czas, rozmiar i treść JSON

Zamiast wklejać token na stałe, lepiej utworzyć żądanie uwierzytelniania: kliknięcie prawym przyciskiem ▸ Dodaj ▸ Żądanie uwierzytelniania HTTP. Następnie należy skonfigurować wywołanie, które pobiera token (na przykład POST /oauth/token), a w jego zakładce Konfiguracja zadeklarować, co ono produkuje:

Produkowany nagłówekWartość
Authorization{{token_type}} {{access_token}}

Wartość jest wyrażeniem obliczanym na treści odpowiedzi żądania uwierzytelniania. Warto od razu podać wyrażenie wygaśnięcia (na przykład {{expires_in}}), aby Restorm samodzielnie odnawiał token.

Po powrocie do żądania GET wystarczy wybrać tę trasę uwierzytelniania na górnym pasku. Nagłówek jest od tej pory wstrzykiwany przy każdym wysłaniu, a odpowiedź 401 automatycznie wywołuje odnowienie tokenu i ponowną próbę.

Szczegóły: Uwierzytelnianie.

  • Gotowa specyfikacja lub kolekcja już istnieje? Plik ▸ Importuj (Ctrl+I) odtwarza całe drzewo: zob. Import i eksport.
  • Kilka wywołań można połączyć w łańcuch i sprawdzić wyniki za pomocą scenariusza.
  • Taki scenariusz można uruchomić w swoim CI: Uruchamianie headless.