# Swagger dla Apollo

## Wymagania

- Node.js \> 10.15.3

## Wersjonowanie API

Zmiana, która nie jest kompatybilna wstecz powinna zmienić pierwszy numer.

Dodanie nowego endpoint powinno zmienić numer drugi.

Dodanie nowego pola w istniejącym endpoint powinno zmienić trzeci numer.

## Uruchomienie

1. Sklonuj te repozytorium
2. W głównym folderze w terminalu/linii komend użyj komendy `npm install`, aby zainstalować wszystkie zależności:
3. Aby uruchomić aplikację użyj komendy: `npm run start`
4. Aplikację uruchom w przeglądarce pod adresem `http://localhost:3030`

## Obsługa

### Konfiguracja serwera oraz klucza autoryzacji

W interfejsie graficznym `Swagger-UI` możemy skonfigurować serwer API, na który zostaną wysłane zapytania oraz klucz autoryzacyjny potrzebny do komunikacji z serwerem. Aby skonfigurować adres serwera należy odpowiednio wypełnić pola `1`, `2` oraz `3`. ![header](<https://docs.logintegra.com/swagger-node/docs/image/header.png>) Przycisk `4` służy do zasilenia Swaggera kluczem autoryzacyjnym, który będzie wysyłany w nagłówków zapytań HTTP. Po naciśnięciu przycisku wprowadź token autoryzacyjny.

### Testowanie zapytań

Swagger-UI umożliwia testowanie zdefiniowanych zapytań. Aby to zrobić, rozwiń dowolne zdefiniowane zapytanie `1` i naciśnij przycisk `2`. ![header](<https://docs.logintegra.com/swagger-node/docs/image/tests.png>) Zostanie uruchomiona sekcja do konstruowania zapytań HTTP. ![header](<https://docs.logintegra.com/swagger-node/docs/image/execute.png>) W polu `1` znajduje się konfigurowalny parametr `APIVersion`. Do komunikacji z publicznym API wpisujemy `v1`. Pusta wartość pozwoli na komunikację z ApolloAPI. W polu `2` definiujemy ciało zapytania. Ostatecznie, przyciskiem `3` wysyłamy zapytanie. Odpowiedź do zapytania wyświetli się poniżej.
