Co je API endpoint?
API endpoint je konkrétní adresa, zpravidla URL, na které API přijme požadavek a pošle zpět odpověď. Jedno API může nabízet mnoho endpointů a každý z nich obstarává jeden úkol. Služba s počasím může mít jeden endpoint pro aktuální předpověď a druhý pro historická data. Zavoláte endpoint, předáte mu potřebné údaje a on vám vrátí výsledek.
V praxi endpoint spojuje cestu v URL s akcí. GET /users/42 si řekne o uživatele s ID 42, zatímco POST /users založí nového. Cesta říká, s čím pracujete, a metoda (GET, POST, PUT, DELETE) říká, co s tím chcete udělat.
Lidsky řečeno
Představte si firemní ústřednu. API je celá firma a každý endpoint je přímá linka. Vytočíte linku obchodu a dovoláte se na obchod, vytočíte fakturaci a dovoláte se na fakturaci. Nevoláte „firmu“ obecně. Voláte přesnou linku k tomu, co potřebujete, a ozve se právě ten stůl.
Proč na tom záleží
- Tady se integrace opravdu odehrává. Propojit dva systémy znamená volat navzájem jejich endpointy. Jsou to konkrétní místa, na kterých každá integrace stojí.
- Jeden endpoint, jeden úkol. Přehledné a dobře pojmenované endpointy dělají API snadno pochopitelným a těžko zneužitelným.
- Určují smlouvu. Každý endpoint stanoví, jaká data čeká a co vrací, a právě proti tomu vývojáři staví.
Na co si dát pozor
- Záměna endpointu za celé API. API je celá služba, endpoint je jedna adresa uvnitř ní. Běžné API jich má spoustu.
- Špatná metoda na správné cestě. Když pošlete
GETtam, kde endpoint čekáPOST, požadavek selže i se správnou URL. Cesta a metoda jdou ruku v ruce. - Chybějící verzování. Změna chování endpointu bez verze typu
/v2/rozbije každého, kdo se spoléhá na tu starou. Než něco změníte, zaveďte verzi. - Endpoint bez ověření. Endpoint dostupný na internetu bez ověření je otevřené dveře. Cokoli, co sahá na skutečná data, chraňte.
Související články
- Co je API? - Širší obrázek: jak spolu software komunikuje.
- Co je REST API? - Nejběžnější styl, jak uspořádat endpointy kolem zdrojů.
- Co je API gateway? - Jedny vstupní dveře, které směrují provoz k mnoha endpointům.
Chcete být o krok napřed?
Nenechte si utéct naše nejlepší postřehy. Žádný spam, jen praktické analýzy, pozvánky na exkluzivní eventy a shrnutí podcastů přímo do vaší schránky.