RESTful
2 minuty czytania
API, które określamy mianem RESTful, spełniają określone kryteria, takie jak używanie HTTP jako podstawowego sposobu komunikacji oraz posiadanie struktury i zasobów, które można odwoływać się przez adresy URL.
Ostatnie oferty pracy
Brak ofert pracy
Powiązane case studies
RESTful oznacza, że dane API jest w pełni zgodne ze standardem REST. Standard wytwarzania oprogramowania REST odnosi się w szczególności do stron internetowych. Aby można było stwierdzić, że napisane przez nas API spełnia standardy REST musi w praktyce spełniać poniższe wymagania:
- Unikalne metody za pomocą których odpytuje API takie jak GET, PUT, DELETE, PATCH określane jako ujednolicony interfejs
- Dane zapytanie jest niezależne od stanu aplikacji, zawsze zwraca to samo, czyli jeżeli zapytamy o zasób o ID=1 w API to niezależnie od tego czy jesteśmy użytkownikiem A czy B powinniśmy uzyskać to samo
- API zwraca komunikaty o tym czy dane zapytanie odniosło sukces czy też zwróciło błąd. API powinno wskazać dokładnie co to był za błąd.
- Zapytanie do API powinno jednoznacznie określać jaki rodzaj zasobu odpytuje i dla odpytywania książek będziemy używać innego
- Klient nie wchodzi bezpośrednio w żadną interakcję z zasobami serwera
- Możliwość używania cache. API musi zwracać informację czy dany zasób jest zachowany i czy może być zachowany
Warto pamiętać, że REST to nie to samo co HTTP, a także REST nie narzuca w żaden sposób typu danych które są zwracane z API. Może to być zarówno JSON jak i zwykły tekst.
Jak wygląda zapytanie typu REST do API
Każde zapytanie API powinno posiadać następujące elementy:
- Nazwę endpointu
- Rodzaj metody
- Nagłówki
- Dane
Przykładowym zapytaniem typu GET będzie
curl -H "Authorization: OAuth <ACCESS_TOKEN>" http://www.example.com/users/2
Praktyczne wskazówki RESTful
Wiele jest ogólników dotyczących RESTful API, ale ciężko znaleźć dobre materiały, które by wskazywały co zrobić by w rzeczywistości nasze API spełniało standardy REST.
Konstrukcja URL w RESTful API
Jedną z najważniejszych rzeczy jest konstrukcja URLa. Url powinien mieć:
- korzystamy tylko z małych liter
- wykorzystujemy myślnik ( - ) zamiast podkreślenia ( _ )
- nie dodajemy typu zwracanych danych do naszego urla, zamiast tego powinno się wykorzystywać Content-Type w headerze
- wykorzystujemy liczbę mnogą w nazwie dla nazw kolekcji np /books/
- wykorzystujemy liczbę pojedyncza dla nazw dokumentów np /books/sciencefiction/
- nie wykorzystujemy metody typu create, delete w nazwie np. błędem jest zrobienie /deletebook/
- możemy wersjonować i powinniśmy dodawać główną wersję api do nazwy np. /v1/books/
Zwracane kody odpowiedzi
API powinno zwracać kody odpowiedzi. Standardem są odpowiedzi zawierające kody błędów o numerach od 2xx, 3xx, 4xx, 5xx. Wszystkie poza odpowiedziami z grupy 200 oznaczają, że w naszym API wystąpił jakiś błąd.
Nasza oferta
Web development
Dowiedz się więcejMobile development
Dowiedz się więcejE-commerce
Dowiedz się więcejProjektowanie UX/UI
Dowiedz się więcejOutsourcing
Dowiedz się więcejPowiązane artykuły
Porównanie sposobów komunikacji między aplikacją frontendową REST vs GraphQL
23 cze 2023
Artykuł poświęcony będzie porównaniu dwóch popularnych sposobów komunikacji między aplikacją frontendową a backendem - REST i GraphQL. Porównamy ich wady i zalety, zwracając szczególną uwagę na sposoby przesyłania danych oraz dostępność dla programistów. Czy warto wybrać GraphQL zamiast REST? Odpowiedź znajdziesz w naszym artykule.
Jam Stack – przełom czy dobrze znana technologia?
17 lut 2022
Jam Stack to technologia, która polega na budowaniu aplikacji internetowych za pomocą statycznie generowanych stron, które są hostowane na serwerach CDN. Jest coraz bardziej popularny wśród programistów, ponieważ oferuje wiele korzyści, takich jak szybkość, niskie koszty utrzymania i bezpieczeństwo.
Entity Object: Podstawa programowania obiektowego
29 kwi 2024
Entity Object odgrywa kluczową rolę w programowaniu obiektowym. Prezentuje on jednak znacznie więcej niż tylko zwiastun interakcji między obiektami - jest elementem, który ułatwia zrozumienie przetwarzania danych i ich manipulacji. W kontekście programowania obiektowego, Entity Object to nie tylko struktura, ale sposób myślenia, który prowadzi do wydajniejszego i bardziej logicznego kodowania.
Touch targets w projektowaniu aplikacji mobilnych
29 kwi 2024
Zapewne korzystałeś już z wielu aplikacji mobilnych, których interfejs wydawał Ci się intuicyjny, a użytkowanie – łatwe i przyjemne. To najprawdopodobniej zasługa celów dotykowych – elementów, nad którymi projektanci aplikacji poświęcają wiele godzin, aby właśnie takie wrażenia mogli doświadczyć użytkownicy.
Zwiększenie wydajności testowania kodu za pomocą xUnit
29 kwi 2024
Testowanie kodu to kluczowy element wyróżniający profesjonalne tworzenie oprogramowania. Zwiększenie wydajności testowania jest jednym z najważniejszych wyzwań deweloperów. Dziś przyjrzymy się, jak dzięki wykorzystaniu xUnit możemy osiągnąć ten cel i przyspieszyć prace nad projektem.
NPS: Mocne strony narzędzia pomiaru satysfakcji
28 kwi 2024
NPS, czyli Net Promoter Score, to skuteczne narzędzie badania satysfakcji klienta, które pomaga firmom zrozumieć, jak dobrze spełniają oczekiwania swoich klientów. Jego naturalna prostota i efektywność sprawiają, że NPS jest coraz częściej wykorzystywane w różnych branżach. Odkryjmy mocne strony tego narzędzia.
Co to jest Middle-of-Funnel (MOF) i dlaczego jest ważne dla strategii marketingowej?
27 kwi 2024
Middle-of-Funnel (MOF) to etap na ścieżce zakupowej, który jest często niedoceniany, ale ma kluczowe znaczenie dla sukcesu strategii marketingowej. Po etapie budowania świadomości brandu, MOF koncentruje się na konwersję zainteresowanych osób w potencjalnych klientów. Pozwala to na budowanie głębszych relacji oraz przygotowanie terenu pod etap decyzji zakupowej.
Zobacz wszystkie artykuły