Co je API a jak se používá ve vývoji webu

Co je API

API (Application Programming Interface) je sada pravidel a protokolů umožňujících různým softwarovým aplikacím vzájemně komunikovat. Představte si API jako číšníka v restauraci, který předá vaše objednávky do kuchyně a přinese vám hotová jídla. Nepotřebujete vědět, jak kuchyně funguje, protože API obstará vše mezi vaším požadavkem a výsledkem, který dostanete zpět.

V kontextu vývoje webu API umožňuje frontendu komunikovat s backendem, mobilním aplikacím přistupovat ke stejné databázi jako web a různým službám vyměňovat si data. Bez API by každá aplikace musela dělat vše sama, zatímco s API můžeme využívat specializované služby pro platby, odesílání e-mailů, předpověď počasí, mapy a stovky dalších funkcí.

Typy API

• REST API – nejběžnější typ, používá HTTP metody (GET, POST, PUT, DELETE)
• GraphQL – flexibilnější, klient si vybere přesně data, která chce
• SOAP – starší standard, používá XML, běžné v bankovnictví a pojišťovnictví
• WebSocket API – obousměrná komunikace v reálném čase
• gRPC – rychlý binární protokol, oblíbený v architektuře mikroslužeb

REST API – moderní webový standard

REST (Representational State Transfer) je architektonický styl využívající standardní HTTP metody. U API projektů zvažte pokročilejší VPS plán pro komunikaci. REST API je dnes zdaleka nejoblíbenějším typem API na webu díky své jednoduchosti a široké podpoře. Každý zdroj na serveru má vlastní URL adresu a klient k těmto zdrojům přistupuje pomocí standardních HTTP metod.

Princip REST znamená, že každý požadavek je nezávislý a server mezi požadavky neukládá stav. Díky tomu jsou REST API škálovatelná, protože požadavky lze rozdělit mezi více serverů bez starostí o relace. Odpovědi jsou obvykle ve formátu JSON, který se snadno čte a parsuje v jakémkoli programovacím jazyce.

HTTP metody v REST API

Čtyři základní HTTP metody v REST odpovídají operacím CRUD, které jsou základem každé aplikace pracující s daty.

• GET – čtení dat (např. GET /api/users vrátí seznam uživatelů)
• POST – vytvoření nového zdroje (např. POST /api/users vytvoří nového uživatele)
• PUT – aktualizace existujícího zdroje (např. PUT /api/users/1 aktualizuje uživatele s ID 1)
• DELETE – smazání zdroje (např. DELETE /api/users/1 smaže uživatele)

Endpointy – adresy zdrojů API

Endpoint je konkrétní URL adresa, kde zdroj API žije. Dobře navržené endpointy jsou intuitivní a řídí se jasnou konvencí pojmenování. Pro zdroje se používají podstatná jména v množném čísle a pro související zdroje hierarchická struktura. Například /api/users pro všechny uživatele, /api/users/42 pro konkrétního uživatele a /api/users/42/orders pro objednávky tohoto uživatele.

Uspořádání endpointů je klíčové pro použitelnost API. Verzování přes URL jako /api/v1/users umožňuje zavádět změny bez narušení stávajících integrací. Filtrování, řazení a stránkování se implementují přes query parametry jako /api/users?role=admin&sort=name&page=2. Dobrá dokumentace endpointů je stejně důležitá jako kód samotný, protože programátoři používající vaše API musí snadno pochopit, jak funguje.

Formát JSON

JSON (JavaScript Object Notation) je standardním formátem pro výměnu dat v komunikaci přes API. Je čitelný pro lidi i stroje, což ho činí ideálním pro ladění a vývoj. JSON podporuje základní datové typy jako řetězce, čísla, booleovské hodnoty, pole a objekty, což stačí k reprezentaci téměř jakékoli datové struktury.

Typická JSON odpověď z API obsahuje požadovaná data spolu s meta informacemi o stavu požadavku, stránkování a případných chybách. Struktura odpovědi by měla být konzistentní v celém API, aby klient vždy věděl, co očekávat. Komprese JSON odpovědí přes gzip snižuje objem přenášených dat a zrychluje komunikaci zejména na mobilních sítích.

Příklad JSON odpovědi

Když si vyžádáte seznam produktů přes GET /api/products, server vrátí strukturovanou JSON odpověď obsahující pole objektů s daty o každém produktu. Každý objekt má pole jako id, name, price, description a category. Odpověď zahrnuje také informaci o celkovém počtu výsledků a stránce pro stránkování, aby klient věděl, zda je k načtení více dat.

Autentizace a zabezpečení

Autentizace API je proces ověření identity klienta odesílajícího požadavek. Bez autentizace by mohl kdokoli přistupovat k vašim datům nebo provádět akce jménem vašich uživatelů. Existuje několik běžných metod autentizace, každá se svými výhodami a využitím v různých scénářích.

Metody autentizace

• API klíč – jednoduchý řetězec posílaný s každým požadavkem, vhodný pro komunikaci mezi servery
• Bearer Token (JWT) – JSON Web Token obsahující zakódované informace o uživateli, standard pro webové a mobilní aplikace
• OAuth 2.0 – složitější protokol umožňující přístup třetích stran bez sdílení hesla, používají ho Google, Facebook a další
• Basic Auth – uživatelské jméno a heslo zakódované v Base64, používá se pouze s HTTPS

Bezpečnostní zásady

Pro komunikaci přes API vždy používejte šifrované HTTPS spojení, protože bez šifrování putují data včetně tokenů a hesel v otevřeném textu. Implementujte rate limiting pro prevenci zneužití, protože bez omezení může útočník poslat miliony požadavků a shodit váš server. Nastavení CORS řídí, které domény mohou k vašemu API přistupovat z prohlížeče, což je důležitá ochrana proti neoprávněným integracím.

Praktické příklady použití API

API jsou všude kolem nás, i když si to neuvědomujeme, od systému DNS po platební procesory. Když na webu vidíte Google mapu, je to Google Maps API. Když platíte kartou online, web komunikuje s API platebního procesoru. Když se přihlašujete přes účet Google nebo Facebook, používá se OAuth API. Předpověď počasí na vašem telefonu pochází z API meteorologické služby.

Běžná API ve vývoji webu

• Stripe nebo PayPal API pro online platby
• SendGrid nebo Mailgun API pro odesílání e-mailů
• Google Maps API pro mapy a geolokaci
• Twilio API pro SMS a telefonní hovory
• Firebase API pro realtime databáze a autentizaci
• Cloudinary API pro optimalizaci a transformaci obrázků

Jak začít s používáním API

Nejlepší způsob, jak se naučit API, je začít s jednoduchými veřejnými API, která nevyžadují autentizaci. Použijte nástroje jako Postman nebo Insomnia pro odesílání požadavků a prohlížení odpovědí bez psaní kódu. Poté přejděte k integraci do svého projektu pomocí fetch nebo axios v JavaScriptu nebo příslušných HTTP knihoven v jiných jazycích.

Dokumentace je vaším nejlepším přítelem při práci s API. Kvalitní API mají podrobnou dokumentaci s příklady požadavků a odpovědí pro každý endpoint. Specifikace Swagger nebo OpenAPI je standardem pro dokumentaci REST API, který také umožňuje automatické generování klientského kódu. Začněte pomalu, experimentujte a brzy budete integrace API považovat za běžnou součást vývoje webu.