Szkolenie Projektowanie, testowanie i utrzymanie REST API z Insomnia

Dzień 1

Wprowadzenie do REST API

• API i architektura REST – pojęcia, ograniczenia architektoniczne, zasoby, reprezentacje i jednolity interfejs
• Przykłady zastosowań API – integracje systemowe, aplikacje webowe i mobilne, automatyzacja oraz usługi zewnętrzne
• REST, GraphQL i SOAP – charakterystyka, różnice, ograniczenia i kryteria doboru

Podstawy HTTP

• Model klient–serwer, bezstanowość i pamięć podręczna – odpowiedzialności stron, kontekst żądania i mechanizmy cache
• Metody HTTP: GET, POST, PUT, DELETE i PATCH – semantyka, bezpieczeństwo, idempotencja i typowe zastosowania
• Statusy odpowiedzi: 2xx, 4xx i 5xx – kategorie rezultatów, błędy klienta, błędy serwera i spójność odpowiedzi
• Nagłówki HTTP: Content-Type, Accept, Authorization i Cache-Control – formaty danych, negocjacja treści, dostęp i buforowanie
• Bezpieczeństwo HTTP: HTTPS i CORS – poufność transmisji, polityka tego samego pochodzenia i kontrola dostępu przeglądarki
• Format danych JSON – typy danych, struktura dokumentu, nazewnictwo pól i czytelność kontraktu

Projekt REST API

• Model zasobów – granice odpowiedzialności, relacje, kolekcje i reprezentacje danych
• URI zasobów – hierarchia, nazewnictwo, identyfikatory i stabilność adresów
• Semantyka metod HTTP – operacje na zasobach, idempotencja i zgodność zachowania endpointów
• Model błędów – kody odpowiedzi, struktura komunikatu, identyfikatory błędów i bezpieczne dane diagnostyczne
• Filtry, porządek wyników, paginacja i wersje API – parametry kontraktu, metadane oraz kompatybilność klientów
• Ograniczenia REST i kompromisy projektowe – pragmatyczne odstępstwa, koszt złożoności i konsekwencje dla konsumentów

Insomnia – podstawy

• Insomnia i Postman – charakterystyka narzędzi, podobieństwa, różnice i scenariusze zastosowania
• Środowisko pracy Insomnia – wymagania, konfiguracja, interfejs i podstawowe obiekty projektu
• Żądania HTTP: GET, POST, PUT, PATCH i DELETE – konfiguracja adresu, parametrów, nagłówków i treści
• Obszary robocze, kolekcje i foldery – organizacja zasobów, podział scenariuszy i współdzielenie ustawień
• Formaty importu i eksportu – kolekcje Insomnia, OpenAPI, Postman, cURL i pliki wymiany danych

Insomnia – konfiguracja żądań

• Parametry zapytania, zmienne ścieżki, nagłówki i body JSON – składnia, kodowanie wartości i kontrola danych wejściowych
• Mechanizmy dostępu: Basic Auth, Bearer Token i OAuth 2.0 – konfiguracja poświadczeń, tokenów i zakresów
• Środowiska, zmienne i sekrety – hierarchia konfiguracji, wartości lokalne i współdzielone oraz ochrona danych wrażliwych

Projekt warsztatowy: API użytkowników

• Projekt endpointów – zasoby użytkowników, operacje CRUD, reprezentacje danych i model błędów
• Kolekcja Insomnia – struktura folderów, nazwy żądań, środowiska i wspólne ustawienia
• Żądania i odpowiedzi – parametry, treści JSON, nagłówki, kody HTTP i analiza rezultatów
• Scenariusze błędów i testy poprawności – nieprawidłowe dane, brak zasobu, konflikt i odmowa dostępu

Dzień 2

Testy API w Insomnia

• Asercje statusów, nagłówków i danych – kryteria poprawności, struktura JSON i wartości pól
• Sekwencje żądań – zależności między krokami, dane z odpowiedzi i przepływy wieloetapowe
• Skrypty pre-request i after-response – przygotowanie danych, modyfikacja żądań, testy odpowiedzi i obsługa błędów
• Dane dynamiczne i zmienne środowiskowe – identyfikatory, tokeny, wartości czasowe i ponowne wykorzystanie rezultatów

Dokumentacja REST API

• OpenAPI 3.0 i 3.1 – ścieżki, operacje, parametry, schematy, odpowiedzi i mechanizmy bezpieczeństwa
• Dokumentacja generowana ze specyfikacji – podgląd kontraktu, walidacja składni i zgodność z kolekcją żądań
• Komentarze, opisy, przykłady i struktura projektu – czytelność dla konsumentów oraz kompletność informacji
• Dystrybucja specyfikacji i kolekcji – eksport, repozytorium, link współdzielony i kontrola wersji

Testy automatyczne i CI

• Diagnostyka i logi w Insomnia – konsola, szczegóły żądania, czas odpowiedzi i analiza błędów
• Inso CLI – testy kolekcji, testy dokumentów, walidacja OpenAPI i tryb CI
• Pipeline CI/CD: GitHub Actions, GitLab CI i Jenkins – kroki testowe, zmienne środowiskowe i kody zakończenia
• Testy regresyjne i smoke tests – zakres przypadków, częstotliwość wykonania i kryteria przerwania pipeline’u
• Serwery mock API – odpowiedzi przykładowe, źródła OpenAPI, warianty chmurowe i lokalne oraz weryfikacja wyników generowanych przy wsparciu AI

Bezpieczeństwo REST API

• Mechanizmy uwierzytelniania i autoryzacji – Basic Auth, tokeny, OAuth 2.0, zakresy dostępu i cykl życia poświadczeń
• Ochrona przed nadużyciami – rate limiting, throttling, limity rozmiaru żądań i kontrola częstotliwości operacji
• Walidacja, CORS i ograniczenia metod – zaufanie do danych wejściowych, minimalne uprawnienia, ochrona sekretów i bezpieczne komunikaty błędów

Ewolucja REST API

• Wersje i kompatybilność – zmiany zgodne i niezgodne, stabilność kontraktu oraz wpływ na klientów
• Cykl deprecjacji i migracje – komunikacja zmian, okres przejściowy, współistnienie wersji i kryteria wyłączenia
• Testy zgodności – walidacja kontraktu, testy konsumentów i kontrola regresji interfejsu
• Struktura projektu, konwencje nazw i środowiska – standardy zespołowe, porządek kolekcji i utrzymanie konfiguracji

Dobre i złe praktyki

• Przypadki z praktyki – skuteczne rozwiązania, typowe błędy projektowe i konsekwencje dla konsumentów
• Czytelność i użyteczność API – przewidywalność, spójność, kompletność dokumentacji i ergonomia integracji
• Antywzorce REST API – czasowniki w URI, niespójne statusy, nadmierne endpointy, przecieki modelu danych i pozorne wersjonowanie

Rezultaty i materiały końcowe

• Checklista REST API – projekt, HTTP, bezpieczeństwo, testy, dokumentacja i cykl życia
• Narzędzia i źródła – dokumentacja standardów, specyfikacje, materiały referencyjne i dalsze obszary rozwoju
• Sesja pytań i odpowiedzi – problemy uczestników, warianty rozwiązań i granice zastosowania omawianych praktyk
• Projekt przykładowy i plik OpenAPI – kolekcja Insomnia, środowiska, testy i kontrakt API