API lub Application Programming Interface przedstawia funkcje i zasady, które umożliwiają interakcję i komunikację między różnymi aplikacjami. Interfejsy te ułatwiają integrację aplikacji, umożliwiając programistom tworzenie potężnych produktów cyfrowych.
API pośredniczy między aplikacjami poprzez żądania i odpowiedzi. Na przykład rejestracja w aplikacji za pośrednictwem istniejącego konta użytkownika na Twitterze odbywa się za pośrednictwem interfejsu API Twittera, który programiści zintegrowali z aplikacją.
API używa różnych protokołów i architektur do wysyłania żądań i odpowiedzi:
- XML-RPC - umożliwia wymianę funkcji między sieciami. XML-RPC wykorzystuje XML do opisywania odpowiedzi/żądań oraz protokoły HTTP do przesyłania informacji z klienta na serwer.
- JSON-RPC - to lekki RPC podobny do XML. Tutaj protokół jest zakodowany w JSON; pozwala na odbieranie połączeń do serwera z asynchronicznymi odpowiedziami.
- SOAP - prosty protokół dostępu do obiektów służący do wymiany ustrukturyzowanych informacji przy implementacji usług internetowych w sieciach komputerowych. SOAP wykorzystuje XML do uwierzytelniania, autoryzacji i komunikacji procesów w systemach operacyjnych. Pozwala klientom wywoływać usługi internetowe i otrzymywać odpowiedzi niezależnie od platformy i języka.
- REST API (representative state transfer) - styl architektoniczny wykorzystujący niezależnie implementacje klient-serwer. REST wykorzystuje do komunikacji protokół HTTP.
W tym poście skupiamy się na REST API, definiujemy go i analizujemy, czym różni się od innych API.
Definiowanie REST API
REST jest stylem architektonicznym służącym do projektowania interfejsów API za pomocą protokołu HTTP. Jego kluczową zaletą jest duża elastyczność.
Programiści wykorzystują REST API wszędzie tam, gdzie istnieje potrzeba dostarczenia danych użytkownikowi aplikacji internetowej lub witryny bezpośrednio z serwera.
Główne składniki REST API:
- Klient - klient lub program uruchamiany po stronie użytkownika (na jego urządzeniu) inicjujący komunikację.
- Serwer - serwer wykorzystujący API jako dostęp do swoich funkcji i danych.
- Resource - dowolna treść (wideo, tekst, obraz), którą serwer przekazuje do klienta.
Jak działa REST API
REST API komunikuje się za pomocą żądań HTTP, realizując następujące funkcje - tworzenie, odczytywanie, aktualizowanie i usuwanie danych. Są one znane również jako operacje CRUD. REST dostarcza informacji o żądanych zasobach i używa czterech metod, aby opisać, co zrobić z zasobem:
- POST - tworzenie zasobu;
- GET - uzyskanie zasobu;
- PUT - aktualizowanie zasobu;
- DELETE - usuwanie zasobu.
Zasób
Zasób to krytyczne pojęcie w REST API, abstrakcja informacji. Może to być dowolna informacja: dokument, obraz, usługa tymczasowa.
Stan zasobu w danym momencie nazywany jest reprezentacją zasobu, która składa się z danych, metadanych opisujących dane oraz hipermedialnych linków ułatwiających klientom przejście do kolejnego stanu.
Informacje te mogą być dostarczone do klienta w różnych formatach: JSON, HTML, XLT, Python lub zwykły tekst. Najpopularniejszym i najczęściej używanym jest JSON, ponieważ jest on czytelny dla człowieka i maszyny, a także niezależny językowo.
Aby uzyskać dostęp do zasobu, klient musi zgłosić żądanie. Po jego otrzymaniu serwer wygeneruje odpowiedź z zakodowanymi danymi o zasobie.
Struktura żądania zawiera cztery główne komponenty: metodę HTTP (CRUD, o którym wspominaliśmy wcześniej), punkty końcowe, nagłówki oraz ciało.
Metoda HTTP opisuje, co należy zrobić z danym zasobem. Tuż powyżej wspomnieliśmy o czterech dostępnych metodach: POST, GET, PUT, DELETE.
Punkt końc owy zawiera URI - Uniform Resource Identifier, który wskazuje jak i gdzie można znaleźć dany zasób. URL lub Uniform Resource Location to najczęściej spotykany typ URI, reprezentujący pełny adres internetowy.
Nagłówki zawierają dane związane z klientem i serwerem. Nagłówki zawierają dane uwierzytelniające: Klucz API, nazwa, adres IP, które należą do komputera, na którym zainstalowany jest serwer, a także informacje o formacie odpowiedzi.
Ciało służy do wysyłania dodatkowych informacji do serwera, takich jak dane, które użytkownik chce dodać.
Zasady działania REST API
REST nie jest przywiązany do żadnej konkretnej technologii ani platformy. Jest niezależny od języków. Nie określa też dokładnie sposobu budowania API. Stosuje jednak sześć ograniczeń architektonicznych. Interfejs można nazwać poprawnym REST API poprzez przestrzeganie tych ograniczeń. Opisują one, jak serwer przetwarza żądania i odpowiada na nie.
Klient-serwer
REST API implementuje styl architektury klient-serwer. Klient wysyła żądania dotyczące zasobów i nie jest związany z przechowywaniem danych. Przechowywanie danych pozostaje wewnątrz serwera. Serwery nie są zaangażowane w komunikację z interfejsem użytkownika. Klient i serwer rozwijają się współzależnie. Ten czynnik sprawia, że REST jest jeszcze bardziej elastyczny i skalowalny.
Jednolity interfejs
Ujednolicony interfejs jest istotnym czynnikiem wyróżniającym REST API. Stanowi on, że istnieje jeden sposób komunikacji z serwerem, nie sugerując się typem aplikacji i urządzenia.
Jednolity interfejs składa się z czterech zasad:
- Identyfikacja zasobów. Każdy zasób musi mieć identyfikację, która jest niezależna od stanu zasobów. W roli identyfikatora występuje adres URL.
- Manipulacja zasobami poprzez reprezentacje. Reprezentacja zasobu (którą posiada klient) zawiera dane wymagane do usunięcia lub modyfikacji zasobu. Klient wysyła reprezentację, którą serwer (obiekt JSON) musi zmodyfikować, usunąć lub dodać.
- Wiadomości samoopisowe. Takie komunikaty posiadają wszystkie informacje dla odbiorcy w celu jego zrozumienia. Nie są wymagane dodatkowe informacje w osobnej dokumentacji lub komunikatach. Każdy komunikat ma wystarczającą ilość informacji dla serwera, aby sparsować żądanie.
- Hipermedia jako silnik stanu aplikacji. Hypermedia wymaga użycia linków dla każdej odpowiedzi, aby klient mógł znaleźć inne zasoby. W REST, hipermedia są używane dla wszystkich interakcji.
Stateless
Oznacza to, że serwer nie zawiera żadnych danych o kliencie. Wszystkie informacje potrzebne do przetworzenia żądania są zawarte w żądaniu. Klient przechowuje wszystkie informacje o sesji.
Cacheable
Każda odpowiedź musi posiadać informację czy jest buforowana czy nie oraz jaki okres czasu odpowiedź może być buforowana. Jeśli jest buforowalna, to w podobnych żądaniach klient może używać tych samych danych bez wielokrotnego wysyłania żądań do serwera. Pomaga to poprawić wydajność i dostępność.
System warstwowy
REST implementuje hierarchię warstw, która tworzy pewne ograniczenia w zachowaniu komponentów. W systemie warstwowym komponenty mogą widzieć tylko komponenty znajdujące się na najbliższych poziomach oraz te, z którymi wchodzą w interakcje.
Kod na żądanie
Jest to opcjonalna funkcja pozwalająca klientom na pobieranie i wykonywanie kodu.
Co wyróżnia REST API?
Sześć zasad REST API można uznać za kluczowe różnice między tym interfejsem a innymi typami. Ponadto, kilka parametrów wyróżnia REST.
Po pierwsze, sama istota REST decyduje o jego niekompatybilności z innymi typami. Jest to styl architektoniczny, w którym architektura reprezentuje zestaw wymagań, których należy przestrzegać, aby zapewnić usługę internetową RESTful. Na przykład SOAP i RPC to protokoły przesyłania wiadomości, które opisują wiadomości. W przeciwieństwie do stylu architektonicznego, który określa tylko wymagania (ograniczenia), które musi spełnić wiadomość.
Struktura
Zazwyczaj API podąża za formatem app-to-app, podczas gdy REST podąża za inną strukturą - Client-Server. Klient i serwer rozwijają się niezależnie, zapewniając większą elastyczność pracy.
Format wymiany wiadomości
Interfejsy API zazwyczaj używają określonych formatów wiadomości; na przykład SOAP używa XML. REST nie stosuje się do tak ścisłych zasad. Może używać niemal dowolnego formatu do wymiany danych. Jednak obecnie najpopularniejszy jest JSON.
Za popularnością JSON stoją oczywiste powody - jest to czytelny dla człowieka i łatwy do analizy format wymiany danych. JSON jest niezależny od języka, można go używać z każdym językiem oprócz JavaScript.
Elastyczność
REST jest elastycznym stylem architektonicznym, więc programiści szeroko go wykorzystują. W porównaniu z SOAP - bardziej złożonym protokołem z zaawansowanymi zabezpieczeniami wymagającymi większej przepustowości, REST składa się z prostych wytycznych, które pozwalają programistom na wykorzystanie tych wymagań w swoim formacie. Architektura ta zapewnia wysoką wydajność, dzięki czemu jest szczególnie pożądana w urządzeniach mobilnych, gdzie liczy się szybkość pobierania.
Jak widzimy, REST ma pewne zalety w stosunku do innych znanych API. Dlatego wszystkie wiodące firmy, takie jak Twitter czy Google, wdrożyły go do swoich produktów. W końcu jest to idealny i łatwy sposób przekazywania danych programistom na całym świecie oraz sprawdzony mechanizm tworzenia wydajnych i skalowalnych interfejsów do tworzenia oprogramowania.
