Web applications

Tasks studies - laboratory

---

Project maintained by dawidolko Hosted on GitHub Pages — Theme by dawidolko

Zadanie 10.1: Wyjaśnić następujące zagadnienia:

• API (Application Programming Interfaces),
• WebAPI (API webowe/API internetowe/interfejsy webowe),
• publiczne a prywatne API,
• ograniczenie liczby żądań (rate limit),
• dokumentacja API,
• formaty danych wykorzystywane na potrzeby wymiany danych z API,
• (przypomnienie) protokół HTTP, żądania/odpowiedzi: nagłówki, ciała,
• (przypomnienie) przekazywanie parametrów w ścieżce URL (Path parameters),
• (przypomnienie) przekazywanie parametrów w query string’u (Query parameters),
• grupy statusów (kodów) HTTP, ich rola, omówić każdą z nich,
• (przypomnienie) metody HTTP: GET i POST,
• inne metody HTTP: PUT, DELETE, PATCH, HEAD, OPTIONS,
• jeszcze inne metody HTTP: CONNECT, TRACE, *
• nagłówek żądania Accept i jego wartości: application/…
• nagłówek żądania/odpowiedzi Content-Type i jego wartości: application/…

API (Application Programming Interfaces)

API to zbiór reguł i specyfikacji, które pozwala różnym programom komunikować się ze sobą. Dzięki API, aplikacje mogą korzystać z funkcji lub danych innych systemów, serwisów lub platform w zorganizowany sposób.

WebAPI (API webowe/API internetowe/interfejsy webowe)

Web API to szczególny rodzaj API, który jest dostępny za pośrednictwem protokołu HTTP i jest często wykorzystywany do tworzenia interfejsów dla aplikacji webowych. Pozwala na interakcję z usługami internetowymi, jak np. pobieranie danych, wysyłanie formularzy czy kontrolowanie obiektów zdalnych.

Publiczne a prywatne API

• Publiczne API są udostępniane przez organizacje na zewnątrz i mogą być używane przez zewnętrzne deweloperów do tworzenia aplikacji, które korzystają z danych lub funkcjonalności oferowanych przez daną organizację.
• Prywatne API są przeznaczone do użytku wewnętrznego w ramach organizacji i nie są dostępne publicznie dla zewnętrznych deweloperów.

Ograniczenie liczby żądań (rate limit)

Ograniczenie liczby żądań do API (rate limiting) ma na celu zapobieganie nadużyciom i zapewnienie równego dostępu dla wszystkich użytkowników. Umożliwia to kontrolę nad tym, jak często użytkownik lub aplikacja może wykonać dane żądanie w określonym czasie.

Dokumentacja API

Dokumentacja API to zestaw informacji opisujących, jak korzystać z danego API, w tym dostępne metody, parametry, formaty danych oraz przykłady użycia. Jest to kluczowe narzędzie dla deweloperów, umożliwiające efektywne wykorzystanie API.

Formaty danych wykorzystywane na potrzeby wymiany danych z API

Najczęściej stosowane formaty danych to JSON (JavaScript Object Notation) i XML (eXtensible Markup Language), które umożliwiają strukturalne reprezentowanie informacji w łatwy do przetwarzania sposób.

Protokół HTTP, żądania/odpowiedzi: nagłówki, ciała

HTTP (Hypertext Transfer Protocol) to protokół komunikacyjny wykorzystywany do przesyłania danych między klientem a serwerem. Żądania i odpowiedzi HTTP składają się z nagłówków (przekazujących metadane) oraz opcjonalnie ciał, które zawierają właściwe dane.

Przekazywanie parametrów w ścieżce URL (Path parameters)

Parametry ścieżki URL są częścią URL-a i są używane do identyfikacji określonych zasobów. Na przykład, w /users/123, 123 jest parametrem ścieżki, który wskazuje na użytkownika o identyfikatorze 123.

Przekazywanie parametrów w query string’u (Query parameters)

Parametry zapytania są dodawane do URL-a po znaku zapytania (?) i służą do przekazywania dodatkowych informacji, które mogą wpłynąć na wynik żądania, np. /search?query=api.

Grupy statusów (kodów) HTTP, ich rola, omówić każdą z nich

• 1xx (Informacyjne): Tymczasowe odpowiedzi informujące, że żądanie zostało otrzymane i przetwarzane.
• 2xx (Sukces): Żądanie zostało pomyślnie otrzymane, zrozumiane i zaakceptowane.
• 3xx (Przekierowania):

Dalsze działania są wymagane w celu zakończenia żądania.

• 4xx (Błędy klienta): Błędy spowodowane przez klienta, np. złe żądanie lub brak uprawnień.
• 5xx (Błędy serwera): Błędy po stronie serwera, które uniemożliwiają przetworzenie żądania.

Metody HTTP: GET i POST

• GET: Używana do pobierania danych z serwera.
• POST: Używana do przesyłania danych do serwera w celu stworzenia lub zmiany zasobu.

Inne metody HTTP: PUT, DELETE, PATCH, HEAD, OPTIONS

• PUT: Używana do zastępowania istniejącego zasobu lub tworzenia nowego, jeśli nie istnieje.
• DELETE: Używana do usuwania zasobu.
• PATCH: Używana do częściowej zmiany zasobu.
• HEAD: Podobna do GET, ale zwraca tylko nagłówki odpowiedzi.
• OPTIONS: Używana do uzyskania opisanych opcji komunikacji dla zasobu.

Jeszcze inne metody HTTP: CONNECT, TRACE, *

• CONNECT: Używana przez serwer proxy do tworzenia dwukierunkowego połączenia strumieniowego między klientem a zdalnym serwerem.
• TRACE: Umożliwia klientowi zobaczenie, co jest przekazywane wzdłuż ścieżki do docelowego serwera.
• *: Zwykle oznacza dowolną metodę.

Nagłówek żądania Accept i jego wartości: application/…

Nagłówek Accept określa, jakie typy mediów są akceptowane w odpowiedzi, np. application/json, application/xml.

Nagłówek żądania/odpowiedzi Content-Type i jego wartości: application/…

Nagłówek Content-Type określa typ mediów zawartości żądania lub odpowiedzi, np. application/json dla formatu JSON.