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.
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.
Networking w IT: jak skutecznie budować i utrzymywać sieć profesjonalnych kontaktów?
13 gru 2024
Networking w IT to kluczowy element kształtowania kariery zawodowej. W dobie dynamicznej cyfrowej transformacji, utrzymywanie sieci profesjonalnych kontaktów staje się niezbędnym narzędziem. Umożliwia wymianę doświadczeń, dzielenie się wiedzą i odkrywanie nowych możliwości. Ale jak skutecznie budować i utrzymywać te relacje? Czytaj dalej, aby dowiedzieć się więcej.
One-pager - Czy warto? Analiza zalet i wad stron internetowych w jednym oknie
13 gru 2024
One-pager to termin, który oznacza stronę internetową składającą się tylko z jednej podstrony. Czy to udogodnienie dla użytkownika czy może jednak problem? Poznajmy zalety i wady tej konstrukcji w kontekście potrzeb biznesowych i oczekiwań odbiorców. Nasza analiza pomoże Ci zdecydować, czy warto inwestować w one-pagery.
Kerning a percepcja tekstu: Oddziaływanie odpowiednich odstępów między literami na czytelność
13 gru 2024
Kerning, termin niewielu znanym poza branżą graficzną, odgrywa kluczową rolę w czytelności tekstu. Odpowiednio dobrane odstępy między literami potrafią nie tylko poprawić estetykę całego dzieła, ale także znacznie wpływają na postrzeganie i przyswajanie treści. Analizując to zjawisko, zrozumiesz, jak subtelne zmiany mogą generować wielkie efekty.
Dark Patterns: Zrozumienie ich natury i konsekwencji ich stosowania
12 gru 2024
Dark Patterns - to manipulacyjne techniki projektowania, które mają na celu skłonienie użytkowników do podejmowania działań niezgodnych z ich wolą. Chociaż powszechne w cyfrowym ekosystemie, ich natura i konsekwencje są często niedoceniane. Czy te praktyki są etycznie poprawne, czy może istnieje granica, której nie powinno się przekraczać? To pytania, które próbujemy odpowiedzieć w tym artykule.
Duże modele językowe (LLM): Mechanizm działania i znaczenie dla przełomu w dziedzinie sztucznej inteligencji
12 gru 2024
W świecie AI, duże modele językowe (LLM) stają się kluczowym elementem ewolucji. Pozwalają maszynom na naturalne 'rozumienie' i generowanie języka ludzkiego. Na czym jednak polega ich działanie? Jak wpłynęły na przełom w sztucznej inteligencji? Sprawdźmy to!
Zobacz wszystkie artykuły