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.
Architektura VIPER: Podstawy i praktyczne wskazówki
14 mar 2024
Architektura VIPER to model, wprowadzony dla zwiększenia przejrzystości i testowalności kodu w projektach iOS. Jego implementacja może wydawać się skomplikowana, dlatego przygotowaliśmy przystępny przewodnik, obejmujący teorię i praktykę. Od podstaw po konkrety - zrozumiesz kluczowe elementy tego rozwiązania, aby skutecznie je wykorzystać.
Zasady i Efektywność Metodyki Disciplined Agile
14 mar 2024
Rozważając różne metodyki Agile, często zapominamy o jednej o nazwie Disciplined Agile (DA). Ta metodyka, choć nie tak popularna jak Scrum czy Kanban, ma w sobie wiele zalet, które mogą przynieść wyraźne korzyści w realizacji projektów IT. Sprawdźmy, jakie zasady rządzą DA i jak skuteczna jest ta metodyka w praktyce.
Strangler Fig Pattern: Skuteczne strategie refaktoryzacji starej aplikacji
14 mar 2024
Pisanie nowego kodu jest ekscytujące. Ale co z częścią IT dotyczącą refaktoryzacji? Jak skutecznie modernizować starą aplikację, nie narażając jej na ryzyko awarii? Strangler Fig Pattern to rozwiązanie, które pozwala na stopniową zamianę starego systemu na nowy. Przeanalizujmy tę inspirującą strategię.
QTest a jakość oprogramowania - jak to działa?
13 mar 2024
Zapewnienie jakości oprogramowania staje się coraz ważniejsze w dynamicznie rozwijającym się środowisku IT. Kluczową rolę w tym procesie odgrywają narzędzia do testowania kodu, takie jak QTest. Poznaj zastosowanie i funkcjonalność QTest w kontekście zapewniania najwyższego standardu tworzonego oprogramowania.
Wprowadzenie do iPaaS: Jak skorzystać z Integration Platform as a Service?
13 mar 2024
Zrozumienie i efektywne korzystanie z iPaaS (Integration Platform as a Service) może być krokiem milowym dla Twojej firmy. Nie tylko ułatwia przepływ danych między różnymi aplikacjami, ale również Ci pozwala skoncentrować się na podstawowych zadaniach, gdyż zautomatyzowana integracja zajmuje się resztą. Nawet jeśli jesteś początkującym, nie musisz się obawiać - ten artykuł pomoże Ci zrozumieć, jak wykorzystać iPaaS w praktyce.
Zobacz wszystkie artykuły