Kurs tworzenia REST API

Lekcja 1 • Adresy URL, URI i nazewnictwo zasobów

Wyjaśnia strukturę URI i sposób adresowania zasobów w REST. Prawidłowe nazewnictwo bezpośrednio wpływa na użyteczność i wykrywalność API.

Lekcja 2 • Podstawy protokołu HTTP

Obejmuje cykl żądanie-odpowiedź HTTP, nagłówki i kody statusu. Stanowi podstawę protokołu, na której opiera się każdy interfejs API REST.

Lekcja 3 • Co to jest API REST

Definiuje REST jako styl architektoniczny i porównuje go z RPC i SOAP. Ustalane jest słownictwo używane w całym kursie.

Lekcja 4 • Sześć ograniczeń architektonicznych REST

Analizuje każde ograniczenie Fieldinga i jego praktyczne implikacje. Zrozumienie ograniczeń prowadzi do podejmowania decyzji projektowych API zgodnych z wytycznymi.

Lekcja 1 • Strategie wersjonowania API

Porównuje podejścia do wersjonowania w URI, nagłówku i typie nośnika. Wybór odpowiedniej strategii zapobiega wprowadzaniu zmian przełamujących dla istniejących klientów.

Lekcja 2 • Projektowanie ładunku żądania i odpowiedzi

Definiuje strukturę ładunku, konwencje nazewnictwa pól i otoki. Dobrze zaprojektowane ładunki zmniejszają liczbę błędów integracji u odbiorców.

Lekcja 3 • Projektowanie podzasobów i relacji

Modeluje relacje między zasobami przy użyciu podejścia zagnieżdżonego i powiązanego. Wybór odpowiedniego wzorca wpływa na wydajność i przejrzystość.

Lekcja 4 • Podstawy modelowania zasobów

Identyfikuje encje domeny i mapuje je na zasoby REST. Prawidłowe modelowanie zapobiega rozrostowi i niespójnościom punktów końcowych.

Lekcja 1 • Struktura i składnia JSON

Omawia typy danych w JSON, zagnieżdżanie i typowe pułapki. JSON jest dominującym formatem ładunku w REST i musi być obsługiwany precyzyjnie.

Lekcja 2 • Negocjacja treści

Wyjaśnia nagłówki Accept i Content-Type do negocjacji formatu. Umożliwia API obsługę wielu formatów z jednego punktu końcowego.

Lekcja 3 • Obsługa danych binarnych i plików

Obejmuje przesyłanie wieloczęściowe, kodowanie Base64 i wzorce pobierania plików. Obsługa danych binarnych jest niezbędna w API mediów i dokumentów.

Lekcja 4 • Definiowanie schematu i walidacja

Używa JSON Schema do definiowania i walidacji ładunków żądań i odpowiedzi. Walidacja schematu wychwytuje błędy, zanim trafią one do logiki biznesowej.

Lekcja 1 • Przepływy OAuth 2.0

Mapuje przepływy kodu autoryzacyjnego, poświadczeń klienta i niejawny na przypadki użycia. OAuth 2.0 jest standardem branżowym dla dostępu delegowanego.

Lekcja 2 • Klucze API i uwierzytelnianie podstawowe

Implementuje proste schematy uwierzytelniania i wyjaśnia ich ograniczenia. Stanowi punkt wyjścia przed wprowadzeniem podejścia opartego na tokenach.

Lekcja 3 • Uwierzytelnianie a autoryzacja

Rozróżnia weryfikację tożsamości od egzekwowania uprawnień. Jasność tych pojęć zapobiega typowym błędom w projektowaniu zabezpieczeń.

Lekcja 4 • Kontrola dostępu oparta na rolach

Egzekwuje uprawnienia na poziomie punktu końcowego i zasobu przy użyciu ról. RBAC zapewnia, że użytkownicy mają dostęp tylko do danych, do których są upoważnieni.

Lekcja 1 • Wzorce błędów walidacji

Obsługuje błędy walidacji wejścia za pomocą precyzyjnych i przydatnych informacji zwrotnych. Błędy walidacji są najczęstszym typem błędów w API REST.

Lekcja 2 • Opanowanie kodów statusu HTTP

Mapuje każdą główną klasę kodów statusu na prawidłowe scenariusze użycia. Dokładne kody statusu są pierwszym sygnałem, którego konsumenci używają do obsługi odpowiedzi.

Lekcja 3 • Standard szczegółów problemu

Stosuje zdefiniowany w RFC format szczegółów problemu dla błędów czytelnych maszynowo. Przyjęcie standardowego formatu poprawia interoperacyjność między zespołami.

Lekcja 4 • Projektowanie strukturalnej odpowiedzi błędu

Definiuje spójny schemat treści błędu z polami kodu, komunikatu i szczegółów. Strukturalne błędy skracają czas debugowania dla konsumentów API.

Lekcja 1 • Dlaczego dokumentacja API ma znaczenie

Ustanawia dokumentację jako produkt dostarczany, a nie coś, co robi się na końcu. Dobra dokumentacja zmniejsza obciążenie zespołu wsparcia i przyspiesza wdrażanie konsumentów.

Lekcja 2 • Dokumentowanie punktów końcowych i schematów

Pisze opisy operacji, parametry, treści żądań i schematy odpowiedzi. Kompletna dokumentacja punktów końcowych umożliwia dokładne generowanie kodu klienta.

Lekcja 3 • Podstawy specyfikacji OpenAPI

Wprowadza strukturę OpenAPI: info, paths, components i servers. Specyfikacja jest jedynym źródłem prawdy dla kontraktu API.

Lekcja 4 • Publikowanie i utrzymywanie dokumentacji

Renderuje interaktywną dokumentację za pomocą Swagger UI i Redoc oraz automatyzuje aktualizacje. Zautomatyzowane publikowanie utrzymuje synchronizację dokumentacji z bazą kodu.

Lekcja 1 • Ograniczanie przepustowości i limitowanie

Chroni infrastrukturę API za pomocą limitów i komunikuje je klientom. Limitowanie zapobiega nadużyciom i zapewnia sprawiedliwy podział zasobów.

Lekcja 2 • Kompresja i optymalizacja ładunku

Stosuje kompresję gzip i Brotli oraz usuwa zbędne dane z ładunku. Kompresja znacząco obniża koszty przepustowości w przypadku API o dużym natężeniu ruchu.

Lekcja 3 • Wzorce stronicowania

Implementuje stronicowanie offsetowe, kursorowe i kluczowe dla dużych kolekcji. Wybór odpowiedniego wzorca wpływa na wydajność i gwarancje spójności.

Lekcja 4 • Filtrowanie, sortowanie i wybór pól

Dodaje parametry zapytania do filtrowania, porządkowania i rzadkich zestawów pól. Te funkcje zmniejszają rozmiar ładunku i niepotrzebny transfer danych.

Lekcja 1 • Bezpieczeństwo transportu i HTTPS

Egzekwuje TLS, konfiguruje HSTS i weryfikuje certyfikaty. Wszystkie produkcyjne API REST muszą bez wyjątku szyfrować dane w tranzycie.

Lekcja 2 • Strategie testowania API

Obejmuje testowanie jednostkowe, integracyjne i kontraktowe dla punktów końcowych REST. Warstwowa strategia testowania wychwytuje defekty przy najniższym możliwym koszcie.

Lekcja 3 • Monitorowanie, logowanie i obserwowalność

Instrumentuje API za pomocą strukturalnych logów, metryk i śledzenia rozproszonego. Obserwowalność umożliwia szybką diagnozę incydentów produkcyjnych.

Lekcja 4 • Podatności bezpieczeństwa w API REST

Identyfikuje ryzyka iniekcji, złamania uwierzytelniania i nadmiernego ujawniania danych. Zrozumienie wektorów ataku jest warunkiem wstępnym skutecznej mitigacji.