Končna točka API je točka povezave med dvema programoma. API-ji imajo končne točke za vsak vir. Končne točke določajo natančno lokacijo vira na strežniku.
Ko odjemalska aplikacija zahteva informacije od strežnika, gredo skozi API. Ki nato dostopa do zahteve in obdela odgovor strežnika. API nato prenese zahtevane informacije od končne točke do aplikacije.
Vaš API je učinkovit, če lahko učinkovito komunicira prek svojih končnih točk. Uporabnikom olajša dostop do virov in izboljša uporabniško izkušnjo.
Kako deluje končna točka API?
Integrirani sistemi komunicirajo prek API-jev. En sistem pošlje zahtevo API-ju z uporabo format, kot je SOAP ali REST. Strežnik prejme zahteve in prenese odgovor nazaj v API. Lokacija tega zahtevanega vira je končna točka.
Preden končna točka obdela zahtevo, mora odjemalec zagotoviti URL, glave in telo. Glave vsebujejo metapodatke o zahtevi in podrobnosti o telesu, poslane strežniku. Strežnik se lahko poveže tudi z bazo podatkov, ki
API metode lahko dostopa.Končne točke API običajno delujejo z metodami HTTP, kot so GET, DELETE, PATCH ali POST. Metode določajo, kako uporabiti končno točko. Ko stranka pošlje zahtevo, jo mora oblikovati tako, da vključuje metodo zahteve in URL, na primer:
DOBITI https://example.com/books/authorsPoimenovanje je težko, ne glede na to, ali gre za končne točke API-ja, omrežne strojne naprave, ali funkcije in spremenljivke. Morali bi se seznaniti z nekaterimi najboljšimi praksami, ki jih lahko uporabite, da zagotovite, da so vaše končne točke API prednost.
1. Uporabite poševnico
Za ločevanje virov URI vedno uporabite poševnice. Poševnice tudi pomagajo prikazati hierarhijo virov. Sledi primer:
https://example.com/books/authors2. Uporabljajte samostalnike, ne glagolov
Za poimenovanje vira uporabite samo samostalnike. Samostalniki opisujejo, čemu je vir namenjen, v nasprotju z glagolom, ki opisuje, kaj vir počne. Tukaj je primer dobrega in slabega načina za poimenovanje končnih točk API-ja.
Dobro poimenovanje:
https://example.com/api/getBooksSlabo poimenovanje:
http://example.com/api/books3. Uporabljajte samostalnike v množini, ne v ednini
Svoje končne točke API-ja morate vedno poimenovati z množinskimi samostalniki. To uporabniku nakazuje, da je na strežniku več kot en vir. Uporaba samostalnika v ednini lahko uporabnika zmede, da misli, da obstaja samo en vir.
Dobro poimenovanje:
https://example.com/api/book/3Slabo poimenovanje:
http://example.com/api/books/34. Uporabljajte male črke
Vse naslove URL vnesite z malimi črkami. To vključuje URL-je končnih točk API-ja. Tukaj je primer:
Dobro poimenovanje:
http://example.com/api/Books/3Slabo poimenovanje:
http://example.com/api/books/35. Za ločevanje besed uporabite vezaje
Za ločevanje združenih besed uporabite vezaje. Vezaji povzročijo bolj berljive fraze kot velike male črke ali podčrtaji. Prav tako so boljši za namene SEO.
Dobro poimenovanje:
https://example.com/api/books/33/front_coverSlabo poimenovanje:
https://example.com/api/books/33/front-cover6. Ne dodajajte datotečnih razširitev
Vašim končnim točkam API-ja vam ni treba dodati pripone datoteke. Čeprav ne vpliva na izpis, razširitev oteži branje vira. Prav tako naredi vir manj prilagodljiv in ga pokvari, če se razširitev v prihodnosti spremeni.
Dobro poimenovanje:
https://example.com/api/books.xmlSlabo poimenovanje:
https://example.com/api/books7. Vključi upravljanje različic
Končne točke API-ja morate vedno poimenovati glede na različico. To je pomembno, če izvajate večje spremembe API-ja. Pomaga pri razlikovanju med dvema ali več različicami API-ja, od koder prihaja vir. Različico lahko označite na začetku končne točke.
Na primer:
https://example.com/api/v3/booksZakaj upoštevati najboljše prakse API-ja?
API-ji so postali hrbtenica sodobnega programiranja. Izboljšujejo sodelovanje, spodbujajo inovacije in izboljšujejo varnost aplikacij.
Ne glede na to, ali uporabljate nova orodja ali upravljate obstoječa, API-ji poenostavijo postopek. Zato je nujno imeti končne točke, ki izboljšajo uporabniško izkušnjo. Poimenovanje in struktura vaših končnih točk API določata delovanje vašega API-ja.
Za ustvarjanje učinkovitih končnih točk API uporabite najboljše prakse.
