Ile metod jest w API?

ile metod jest w API? Poznaj 5 najważniejszych typów

Kwestia tego, ile metod jest w API, ma kluczowe znaczenie dla każdego, kto chce sprawnie zarządzać przepływem danych w aplikacjach. Błędne przypisanie akcji do niewłaściwego zapytania skutkuje niestabilnością systemu oraz poważnymi błędami w przetwarzaniu informacji. Prawidłowa implementacja mechanizmów buduje bezpieczne i wydajne rozwiązania technologiczne.

Ile metod jest w API? Krótka odpowiedź

Odpowiedź zależy nieco od wybranego protokołu, ale większość nowoczesnych interfejsów REST API opiera się dokładnie na pięciu podstawowe metody REST API. Są to GET, POST, PUT, PATCH oraz DELETE. To absolutny standard w branży.

Analiza ruchu w nowoczesnych aplikacjach pokazuje, że te pięć operacji obsługuje większość wszystkich żądań sieciowych.^[1] Dlaczego? Ponieważ idealnie pokrywają się one z potrzebami zarządzania danymi. Ale istnieje jeden niepozorny błąd w aktualizacji zasobów, który odpowiada za prawie 40% awarii na produkcji - wyjaśnię to dokładnie w sekcji o różnica między PUT a PATCH poniżej.

Standardowe operacje CRUD w API i ich odpowiedniki

Każdy programista wcześniej czy później spotyka się z akronimem CRUD. Oznacza on Create, Read, Update, Delete. W świecie REST API te cztery standardowe operacje CRUD w API mają swoje bezpośrednie odpowiedniki w metodach żądań HTTP.

Zestawienie wygląda następująco: GET (Read): Pobieranie danych. Służy wyłącznie do odczytu i nie powinien nigdy modyfikować stanu serwera. POST (Create): Tworzenie nowych danych, na przykład dodanie nowego użytkownika. PUT (Update): Aktualizacja lub całkowite zastąpienie istniejącego zasobu. PATCH (Update): Częściowa aktualizacja zasobu. DELETE (Delete): Usuwanie danych z systemu.

Kiedy po raz pierwszy budowałem własne API i zastanawiałem się, ile metod jest w API, myślałem, że używanie POST do wszystkiego to świetny pomysł. To był koszmar. Spędziłem trzy dni na szukaniu błędu, który okazał się problemem z duplikacją danych przy ponowieniach żądań. Wdrożenie właściwych metod HTTP zgodnie ze standardem REST redukuje czas rozwiązywania problemów z siecią.^[3] Zdecydowanie warto się ich trzymać.

Dlaczego GET i DELETE są wyjątkowe?

Metoda GET jest z założenia bezpieczna. Możesz ją wywołać tysiąc razy, a stan serwera pozostanie niezmieniony. Z kolei DELETE jest operacją, która usuwa zasób. Co ciekawe, drugie i kolejne wywołanie DELETE na tym samym zasobie po prostu zwróci błąd informujący, że element nie istnieje.

Różnica między PUT a PATCH (Rozwiązanie odwiecznego problemu)

Bądźmy szczerzy - nikt nie uczy się projektowania interfejsów sieciowych bez przypadkowego wyczyszczenia bazy danych. To właśnie tutaj tkwi błąd, o którym wspomniałem wcześniej.

Wielu deweloperów używa PUT i PATCH zamiennie. To ogromny błąd. Metoda PUT ma za zadanie nadpisać cały obiekt. Jeśli twój obiekt użytkownika ma imię, nazwisko i adres, a ty wyślesz żądanie PUT tylko z imieniem, serwer usunie nazwisko i adres. Całkowicie. Z kolei PATCH to operacja chirurgiczna - modyfikuje tylko to, co jej wskażesz.

Użycie metody PATCH zamiast PUT przy dużych obiektach może zmniejszyć obciążenie sieci, ponieważ przesyłasz tylko zmienione fragmenty danych.^[4] To szczególnie ważne w aplikacjach mobilnych, gdzie każdy kilobajt ma znaczenie.

Mniej znane metody HTTP w API: HEAD i OPTIONS

Oprócz wielkiej piątki, protokół posiada jeszcze kilka innych narzędzi. Dwie z nich są niezwykle przydatne z technicznego punktu widzenia, choć rzadko używane bezpośrednio przez użytkowników.

Kiedy debugujesz błędy na produkcji o drugiej w nocy i logi serwera nie pokazują nic sensownego, a system powiadomień rzuca setkami alertów na minutę i nie wiesz, dlaczego aplikacja frontendowa odrzuca połączenia... Zacznij od sprawdzenia metody OPTIONS. Ta operacja jest często wysyłana automatycznie przez przeglądarki (tzw. preflight request), aby sprawdzić, na jakie akcje serwer w ogóle pozwala (mechanizm CORS).

Metoda HEAD z kolei działa identycznie jak GET, ale serwer zwraca tylko same nagłówki, bez ciała odpowiedzi. Idealne do sprawdzania, czy duży plik w ogóle istnieje, bez konieczności jego pobierania.

Porównanie metod pod kątem bezpieczeństwa i idempotentności

GET

- Bezpieczna - nigdy nie zmienia stanu zasobów na serwerze

- Tak - wielokrotne wywołanie daje ten sam efekt systemowy

- Doskonałe - odpowiedzi są domyślnie cache'owane przez przeglądarki

POST

- Zmienia stan - tworzy nowe zasoby

- Nie - podwójne wywołanie utworzy dwa identyczne zasoby

- Zazwyczaj nie jest cache'owane, wymaga specjalnej konfiguracji

PUT (⭐ Najczęściej źle rozumiana)

- Zmienia stan - całkowicie nadpisuje istniejący zasób

- Tak - wielokrotne nadpisanie tymi samymi danymi daje ten sam wynik

- Rzadko cache'owane

Katastrofa aktualizacji koszyka w e-commerce

Tomek, młody programista z Krakowa, pracował nad nowym modułem koszyka w aplikacji e-commerce. Otrzymał proste zadanie: zaktualizować status zamówienia na 'opłacone' w momencie powrotu klienta z bramki płatniczej.

Użył do tego metody PUT, wysyłając w żądaniu jedynie mały fragment JSON z nowym statusem. Z pozoru wszystko na froncie działało poprawnie. Jednak w tle serwer zachował się zgodnie ze standardem i nadpisał cały obiekt zamówienia, kasując adresy wysyłki i listę produktów. Zniknęły dane z ponad 300 transakcji.

Po 14 godzinach debugowania i przywracania bazy z kopii zapasowej, Tomek zrozumiał swój błąd. Zastąpił problematyczne wywołania metodą PATCH, która modyfikuje wyłącznie przekazane w żądaniu pole, ignorując resztę struktury obiektu.

Czas przetwarzania tych żądań spadł o 25%, ponieważ serwer nie musiał przetwarzać całego modelu. Co ważniejsze, incydenty z utratą danych zniknęły całkowicie, a Tomek nauczył się, że wybór metody to nie tylko kwestia estetyki kodu.