Koncový bod API je bod spojenia medzi dvoma softvérovými programami. Rozhrania API majú koncové body pre každý zdroj. Koncové body určujú presné umiestnenie prostriedku na serveri.
Keď klientska aplikácia požaduje informácie zo servera, prechádza cez API. Ktorý potom pristúpi k požiadavke a spracuje odpoveď zo servera. Rozhranie API potom prenesie požadované informácie z koncového bodu do aplikácie.
Vaše API je efektívne, ak dokáže efektívne komunikovať prostredníctvom svojich koncových bodov. Uľahčuje používateľom prístup k zdrojom a zlepšuje používateľskú skúsenosť.
Ako funguje koncový bod API?
Integrované systémy komunikujú prostredníctvom API. Jeden systém odošle požiadavku do API pomocou formát ako SOAP alebo REST. Server prijme požiadavky a odošle odpoveď späť do API. Umiestnenie požadovaného zdroja je koncovým bodom.
Predtým, ako koncový bod spracuje požiadavku, klient musí poskytnúť URL, hlavičky a telo. Hlavičky obsahujú metaúdaje o požiadavke a údaje o tele zaslané na server. Server sa môže pripojiť aj k databáze, ktorá
API metódy môže pristupovať.Koncové body API zvyčajne pracujú s metódami HTTP, ako sú GET, DELETE, PATCH alebo POST. Metódy určujú, ako používať koncový bod. Keď klient odošle požiadavku, musí ju sformulovať tak, aby obsahovala metódu požiadavky aj adresu URL, napríklad:
GET https://example.com/books/authorsPomenovanie je ťažké, či už ide o koncové body API, sieťové hardvérové zariadeniaalebo funkcie a premenné. Mali by ste sa dozvedieť o niektorých osvedčených postupoch, ktoré môžete použiť na zabezpečenie toho, aby vaše koncové body API boli aktívom.
1. Použite lomku
Na oddelenie zdrojov URI vždy používajte lomky. Lomky tiež pomáhajú zobraziť hierarchiu zdrojov. Nasleduje príklad:
https://example.com/books/authors2. Používajte podstatné mená, nie slovesá
Na pomenovanie zdroja by ste mali používať iba podstatné mená. Podstatné mená popisujú, na čo slúži zdroj, na rozdiel od slovesa, ktoré popisuje, čo zdroj robí. Tu je príklad dobrého a zlého spôsobu pomenovania koncových bodov API.
Dobré pomenovanie:
https://example.com/api/getBooksZlé pomenovanie:
http://example.com/api/books3. Používajte podstatné mená v množnom čísle, nie v jednotnom čísle
Koncové body rozhrania API by ste mali vždy pomenovať v podstatných menách v množnom čísle. Používateľovi to signalizuje, že na serveri je viac ako jeden zdroj. Použitie podstatného mena v jednotnom čísle môže zmiasť používateľa, aby si myslel, že existuje iba jeden zdroj.
Dobré pomenovanie:
https://example.com/api/book/3Zlé pomenovanie:
http://example.com/api/books/34. Používajte malé písmená
Všetky adresy URL by ste mali zadať malými písmenami. To zahŕňa adresy URL koncových bodov rozhrania API. Tu je príklad:
Dobré pomenovanie:
http://example.com/api/Books/3Zlé pomenovanie:
http://example.com/api/books/35. Na oddelenie slov použite spojovníky
Na oddelenie kombinovaných slov použite pomlčky. Výsledkom pomlčiek sú čitateľnejšie frázy ako veľké písmená alebo podčiarkovníky. Sú tiež lepšie pre účely SEO.
Dobré pomenovanie:
https://example.com/api/books/33/front_coverZlé pomenovanie:
https://example.com/api/books/33/front-cover6. Nepridávajte prípony súborov
Ku koncovým bodom rozhrania API nemusíte pridávať príponu súboru. Hoci to neovplyvňuje výstup, rozšírenie sťažuje čítanie zdroja. Tiež to robí zdroj menej flexibilným a preruší ho, ak sa rozšírenie v budúcnosti zmení.
Dobré pomenovanie:
https://example.com/api/books.xmlZlé pomenovanie:
https://example.com/api/books7. Zahrnúť verzovanie
Koncové body rozhrania API by ste mali vždy pomenovať podľa verzie. Je to dôležité, ak robíte veľké zmeny v rozhraní API. Pomáha rozlišovať medzi dvoma alebo viacerými verziami API, z ktorých zdroj pochádza. Verziu môžete uviesť na začiatku koncového bodu.
Napríklad:
https://example.com/api/v3/booksPrečo zvážiť osvedčené postupy rozhrania API?
Rozhrania API sa stali základom moderného programovania. Zlepšujú spoluprácu, podporujú inovácie a zlepšujú bezpečnosť aplikácií.
Či už používate nové nástroje alebo spravujete existujúce, API zjednodušujú proces. Preto je nevyhnutné mať koncové body, ktoré zlepšujú používateľskú skúsenosť. Pomenovanie a štruktúra vašich koncových bodov API určujú výkon vášho API.
Uistite sa, že používate osvedčené postupy na vytváranie efektívnych koncových bodov rozhrania API.
