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.
Zastosowanie wzorca VO (Value Object) w projektach
26 kwi 2024
Wzorzec VO, czyli Value Object, to istotny element każdego projektu programistycznego. Często nie doceniany, a cichym bohaterem zwiększających efektywność kodu, jest sposobem na skuteczne zarządzanie danymi w aplikacjach. W tej serii artykułów pokażemy praktyczne zastosowania tego wzorca projektowego, które pomogą Ci w codziennej pracy dewelopera.
Content Security Policy (CSP) - Skuteczne techniki zabezpieczania strony internetowej
26 kwi 2024
Content Security Policy (CSP) to potężna technika bezpieczeństwa sieci, która służy do ograniczania zawartości możliwej do załadowania przez Twoją stronę. Dzięki niej, możemy skutecznie chronić naszą witrynę przed atakami takimi jak Cross-Site Scripting (XSS). W tym artykule zgłębimy najważniejsze aspekty konfiguracji CSP oraz przedstawimy przykłady jej zastosowań w praktyce.
Co to jest Xcode i jak go używać?
26 kwi 2024
Xcode to rozbudowane środowisko programistyczne firmy Apple, stworzone z myślą o tworzeniu aplikacji na urządzenia z systemem iOS czy macOS. Nasuwa się pytanie: jak skorzystać z tego narzędzia? W poniższym artykule przedstawimy najważniejsze funkcje Xcode oraz kroki prowadzące do pierwszego, własnego projektu.
Jak skutecznie wykorzystać marketing mobilny w strategii marki?
25 kwi 2024
W dobie cyfryzacji, marketing mobilny staje się niezbędnym narzędziem w promocji i rozwoju biznesu. W tym artykule poznamy skuteczne strategie.
MSTest: Co to jest i jakie są jego główne cechy?
25 kwi 2024
MSTest, wszechstronne narzędzie do testowania jednostkowego stworzone przez Microsoft, zyskuje na popularności wśród programistów .NET. Czy to ze względu na jego natywną integrację z Visual Studio, czy też za sprawą rozbudowanych funkcji? Pora rozejrzeć się po pokładzie MSTest, zgłębiając kluczowe aspekty jego architektury i funkcji.
Zobacz wszystkie artykuły