Obsah

REST API (Representational State Transfer)

REST API je rozhraní, které využívá principy architektury REST pro výměnu dat mezi klientem (např. webový prohlížeč) a serverem. Je založeno na bezstavovosti a využívá standardní metody protokolu HTTP.

1. Základní principy RESTu

Aby bylo rozhraní považováno za „RESTful“, mělo by splňovat několik pravidel:

—

2. HTTP Metody (Slovesa)

REST API využívá HTTP metody k definování akce, která se má se zdrojem provést:

Metoda Akce Význam
GET Čtení Získání dat o zdroji (např. seznam uživatelů).
POST Vytvoření Vytvoření nového zdroje (např. registrace uživatele).
PUT Aktualizace Nahrazení stávajícího zdroje novými daty.
PATCH Částečná aktualizace Úprava pouze části zdroje (např. změna hesla).
DELETE Smazání Odstranění zdroje.

—

3. Zdroje a URL struktura

V RESTu je vše považováno za zdroj (resource), ke kterému se přistupuje pomocí unikátní adresy (URI). Názvy v URL by měly být podstatná jména v množném čísle.

Příklady:

—

4. Formát dat (JSON)

Ačkoliv REST může teoreticky používat i XML nebo text, naprostým standardem je dnes JSON (JavaScript Object Notation). Je lehký, dobře čitelný pro lidi a snadno zpracovatelný pro stroje.

// Příklad odpovědi ve formátu JSON
{
  "id": 42,
  "jmeno": "Jan Novák",
  "email": "jan.novak@example.com"
}

—

5. Stavové kódy HTTP

Server informuje klienta o výsledku požadavku pomocí číselných kódů:


Související články:

Tagy: programming web api rest json http architecture