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
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.
Powią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.
Priming w strategiach marketingowych: jak to działa?
26 lis 2023
Priming to wyrafinowane narzędzie w strategiach marketingowych, oparte na psychologicznych aspektach percepcji. Przez subtelne wywołanie skojarzeń, możliwe jest kierowanie zachowaniami i decyzjami klientów. Jak jednak działa ten mechanizm i jak może być skutecznie wykorzystany w praktyce? Zanurzmy się w fascynujący świat marketingu ukierunkowanego przez priming.
PMBoK: Klucz do skutecznego zarządzania projektami. Jak go prawidłowo zastosować?
26 lis 2023
Klucz do skutecznego zarządzania projektami często leży w dostosowaniu odpowiednich metodologii do specyfiki danej organizacji. W tym kontekście, PMBoK (Project Management Body of Knowledge) wyłania się jako jedno z podstawowych narzędzi wykorzystywanych przez profesjonalistów. Artykuł ten ma na celu wyjaśnić, jak skutecznie zastosować PMBoK w praktyce, co pozwoli na sprawniejsze i bardziej efektywne prowadzenie projektów.
Atom - Czy ten edytor kodu jest idealnym narzędziem na co dzień?
25 lis 2023
W świecie programowania narzędzia są kluczowe. Edytor kodu może sprawić, że proces tworzenia aplikacji będzie przyjemnością albo koszmarem. Jeden z nich, Atom, zdobywa coraz większą popularność. Czy jest to idealne, codzienne narzędzie dla developerów?
Feature Flag: Odkrywamy potęgę kontroli funkcjonalności
25 lis 2023
Feature Flags, znane również jako Flagi Funkcjonalne, to potężne narzędzia dające programistom wyjątkową kontrolę nad funkcjonalnościami aplikacji. Kiedy powinniśmy z nich korzystać? Jak wprowadzają elastyczność do procesu rozwoju oprogramowania? W naszym artykule zgłębimy tę tematykę.
SpecFlow: Zrozum i Zastosuj Narzędzie do Behavior-Driven Development
25 lis 2023
SpecFlow, popularne narzędzie do Behavior-Driven Development (BDD), znacznie ułatwia tworzenie aplikacji poprzez skupienie się na funkcjonalności z perspektywy użytkownika. Ten artykuł pomoże Ci zrozumieć SpecFlow i efektywnie wykorzystać jego możliwości, aby przyspieszyć proces tworzenia oprogramowania.
Zobacz wszystkie artykuły