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.
Wzorzec projektowy Bridge: Definicja, zasady działania i praktyczne zastosowanie
26 mar 2024
Bridge to jeden z kluczowych wzorców projektowych, który usprawnia proces tworzenia programów. W naszym artykule przyjrzymy się, jakie są podstawowe zasady działania tego patternu, jego definicji i jak jest stosowany w praktyce, aby lepiej zrozumieć jego istotę i przewagi.
Testcontainers: Co to jest i jakie są jego główne zalety w testowaniu oprogramowania?
25 mar 2024
Testcontainers rewolucjonizują testowanie oprogramowania, zapewniając narzędzia do elastycznego i efektywnego tworzenia testów. Jest to biblioteka, która umożliwia uruchamianie różnych testów za pomocą kontenerów Docker. Testcontainers służy m.in. do tworzenia izolowanych środowisk testowych, oferując wiele kluczowych korzyści. W tym artykule przyjrzymy się definicji, kluczowych korzyściach i praktycznym zastosowaniom Testcontainers.
Adaptive Web Design: Zalety i korzyści zastosowania
22 mar 2024
Adaptive Web Design, związany nierozerwalnie z epoką urządzeń mobilnych, stał się filarem sukcesu nowoczesnej strony internetowej. Jego podstawą jest tworzenie stron zorientowanych na użytkownika, które dostosowują się do różnorodnych urządzeń. W świecie, gdzie odwiedzający korzystają z rozmaitych platform, rola Adaptive Web Design rośnie lawinowo, przyspieszając, i jest kluczem do osiągnięcia wyróżniającej się i skutecznej obecności online
Czym jest targetowanie behawioralne w marketingu?
22 mar 2024
Targetowanie behawioralne to silne narzędzie w arsenale strategii marketingowych, które pozwala firmom na zrozumienie i skuteczne zaspokojenie potrzeb swoich klientów. Wspiera decyzje zakupowe, analizując zachowania użytkownika, i dostarcza spersonalizowane treści, czyniąc klienta bardziej zaangażowanym.
Parse w praktyce: Efektywne wykorzystanie tej technologii w procesie budowy aplikacji webowych
22 mar 2024
Czy kiedykolwiek zastanawiałeś się, jak skutecznie wykorzystać technologię Parse w procesie budowy aplikacji webowych? W niniejszym artykule postaramy się przedstawić praktyczne zastosowania Parse - backend-as-a-service (BaaS), który oferuje elastyczne i skalowalne rozwiązania dla deweloperów.
Zobacz wszystkie artykuły