REST API

Co to jest REST API?

REST (Representational State Transfer) to styl architektury komunikacji między klientem a serwerem oparty na protokole HTTP. REST API umożliwia wymianę danych w sposób bezpieczny, wydajny i ustandaryzowany, najczęściej w formacie JSON

Podstawowe zasady REST API (6 głównych filarów)

1. Architektura klient-serwer – klient i serwer działają niezależnie, co zwiększa skalowalność i modularność.

2. Bezstanowość (stateless) – każde żądanie musi zawierać wszystkie dane potrzebne do jego obsługi; serwer nie przechowuje stanu sesji.

3. Cacheowalność – odpowiedzi mogą być buforowane, co poprawia wydajność.

4. System warstwowy – API może mieć pośrednie warstwy (np. uwierzytelnianie, load-balancing).

5. Jednolity interfejs (uniform interface) – komunikacja odbywa się przez ustandaryzowane metody HTTP i identyfikatory zasobów (URI).

6. Kod na żądanie (opcjonalnie) – serwer może wysyłać kod wykonywalny do klienta

Standardowe metody HTTP w REST API

• GET – pobiera zasób lub kolekcję zasobów.

• POST – tworzy nowy zasób lub przesyła dane do przetworzenia.

• PUT – aktualizuje cały zasób.

• PATCH – częściowo aktualizuje zasób.

• DELETE – usuwa zasób

Co oznacza bezstanowość w REST?

Bezstanowość oznacza, że serwer nie przechowuje informacji o stanie klienta między żądaniami. Każde żądanie zawiera wszystkie potrzebne dane, np. token uwierzytelniający, co ułatwia skalowanie i niezawodność API.

Jak identyfikowane są zasoby w REST API?

Zasoby są identyfikowane przez URI (Uniform Resource Identifier), zwykle adres URL. Każdy zasób (np. użytkownik, produkt) ma swój unikalny identyfikator, co pozwala na jednoznaczny dostęp i manipulację danymi

Co to jest URI (Uniform Resource Identifier)?

URI (Uniform Resource Identifier) to standardowy identyfikator internetowy, który służy do jednoznacznej identyfikacji zasobów w sieci. Może to być zarówno nazwa zasobu (URN), jak i jego adres (URL). URI jest zapisywany jako ciąg znaków według określonej składni i pozwala na lokalizację lub identyfikację zasobu, np. dokumentu, usługi czy obiektu danych.

• URL (Uniform Resource Locator) to szczególny typ URI, który oprócz identyfikacji zasobu wskazuje też sposób dostępu do niego, np. protokół i ścieżkę (np. https://api.example.com/users/1).

• W REST API każdy zasób jest reprezentowany przez unikalny URI, który klient wykorzystuje do wykonywania operacji (GET, POST, PUT, DELETE) na tym zasobie.

• URI składa się zwykle ze schematu (np. http, https), dwukropka, a następnie części hierarchicznej (np. ścieżki) lub niehierarchicznej.

Podsumowując: URI to kluczowy element REST API, umożliwiający jednoznaczną identyfikację i dostęp do zasobów w aplikacji webowej

Jakie są typowe statusy HTTP zwracane przez REST API?

• 2xx – powodzenie (np. 200 OK, 201 Created)

• 4xx – błąd klienta (np. 400 Bad Request, 401 Unauthorized)

• 5xx – błąd serwera (np. 500 Internal Server Error)

Dlaczego REST API jest ważne dla frontend developera?

Frontend developer korzysta z REST API, aby pobierać, tworzyć, aktualizować i usuwać dane w aplikacji. Znajomość REST pozwala na efektywną integrację z backendem i tworzenie dynamicznych interfejsów użytkownika.

Co to jest jednolity interfejs w REST?

Jednolity interfejs to zasada, że klient i serwer komunikują się za pomocą ustandaryzowanych metod i formatów (HTTP + JSON/XML), co ułatwia interoperacyjność i utrzymanie API.

Co to jest cacheowalność w REST?

Cacheowalność oznacza, że odpowiedzi serwera mogą być przechowywane przez klienta lub pośrednie warstwy, co zmniejsza liczbę zapytań i zwiększa wydajność aplikacji.

Co to jest HATEOAS?

HATEOAS (Hypermedia As The Engine Of Application State) to zasada REST, gdzie odpowiedź API zawiera linki do dostępnych dalszych akcji, co umożliwia klientowi nawigację po zasobach bez konieczności znajomości struktury API z góry (często opcjonalne).

{
  "_embedded": {
    "carList": [
      {
        "carId": 1,
        "brand": "Mercedes",
        "model": "GLC 300",
        "color": "NAVY_BLUE",
        "_links": {
          "self": {
            "href": "http://localhost:8080/cars/1"
          }
        }
      },
      {
        "carId": 2,
        "brand": "Maserati",
        "model": "Quatroporte",
        "color": "MARINE",
        "_links": {
          "self": {
            "href": "http://localhost:8080/cars/2"
          }
        }
      },
      {
        "carId": 3,
        "brand": "Alfa Romeo",
        "model": "Giulia",
        "color": "RED",
        "_links": {
          "self": {
            "href": "http://localhost:8080/cars/3"
          }
        }
      }
    ]
  },
  "_links": {
    "self": {
      "href": "http://localhost:8080/cars"
    }
  }
}

Co to jest http

HTTP (Hypertext Transfer Protocol) to podstawowy protokół komunikacyjny w sieci internetowej, który umożliwia wymianę danych między klientem (np. przeglądarką) a serwerem. Działa na zasadzie modelu klient-serwer, gdzie klient wysyła żądanie HTTP, a serwer odpowiada odpowiednią odpowiedzią.