API lõpp-punkt on ühenduspunkt kahe tarkvaraprogrammi vahel. API-del on iga ressursi jaoks lõpp-punktid. Lõpp-punktid määravad ressursi täpse asukoha serveris.
Kui klientrakendus küsib serverilt teavet, läheb see läbi API. Mis seejärel pääseb päringule juurde ja töötleb serverilt saadud vastust. Seejärel edastab API nõutud teabe lõpp-punktist rakendusse.
Teie API on tõhus, kui see suudab oma lõpp-punktide kaudu tõhusalt suhelda. See hõlbustab kasutajatel juurdepääsu ressurssidele, parandades kasutajakogemust.
Kuidas API lõpp-punkt töötab?
Integreeritud süsteemid suhtlevad API-de kaudu. Üks süsteem saadab API-le päringu, kasutades vormingus nagu SOAP või REST. Server võtab päringud vastu ja edastab vastuse API-le tagasi. Selle taotletud ressursi asukoht on lõpp-punkt.
Enne kui lõpp-punkt päringu töötleb, peab klient esitama URL-i, päised ja keha. Päised sisaldavad päringu metaandmeid ja serverisse saadetud keha üksikasju. Server saab ühenduse luua ka andmebaasiga, mis
API meetodid pääseb juurde.API lõpp-punktid töötavad tavaliselt HTTP-meetoditega, nagu GET, DELETE, PATCH või POST. Meetodid määravad, kuidas lõpp-punkti kasutada. Kui klient saadab päringu, peab ta selle sõnastama nii, et see sisaldaks päringu meetodit ja URL-i, näiteks:
SAADA https://example.com/books/authorsNime panemine on keeruline, olgu selleks API lõpp-punktid, võrku ühendatud riistvaraseadmedvõi funktsioonid ja muutujad. Peaksite õppima mõnede parimate tavade kohta, mida saate kasutada, et tagada oma API lõpp-punktide väärtus.
1. Kasutage kaldkriipsu
Kasutage URI ressursside eraldamiseks alati kaldkriipsu. Kaldkriipsud aitavad näidata ka ressursside hierarhiat. Järgnev on näide:
https://example.com/books/authors2. Kasutage nimisõnu, mitte tegusõnu
Ressursi nimetamiseks peaksite kasutama ainult nimisõnu. Nimisõnad kirjeldavad, mille jaoks ressurss on mõeldud, mitte tegusõnaga, mis kirjeldab ressurssi. Siin on näide heast ja halvast viisist API lõpp-punktide nimetamiseks.
Hea nimetus:
https://example.com/api/getBooksHalb nimetus:
http://example.com/api/books3. Kasutage mitmuse nimisõnu, mitte ainsuses
Peaksite oma API lõpp-punktid alati nimetama mitmuses. See näitab kasutajale, et serveris on rohkem kui üks ressurss. Ainsuse nimisõna kasutamine võib kasutajas segadusse ajada, et ta arvab, et on ainult üks ressurss.
Hea nimetus:
https://example.com/api/book/3Halb nimetus:
http://example.com/api/books/34. Kasutage väiketähti
Peaksite sisestama kõik URL-id väiketähtedega. See hõlmab API lõpp-punkti URL-e. Siin on näide:
Hea nimetus:
http://example.com/api/Books/3Halb nimetus:
http://example.com/api/books/35. Kasutage sõnade eraldamiseks sidekriipse
Kombineeritud sõnade eraldamiseks kasutage sidekriipse. Sidekriipsud toovad kaasa loetavamad fraasid kui kaameli tähed või allkriipsud. Need on paremad ka SEO eesmärkidel.
Hea nimetus:
https://example.com/api/books/33/front_coverHalb nimetus:
https://example.com/api/books/33/front-cover6. Ärge lisage faililaiendeid
Te ei pea API lõpp-punktidele faililaiendit lisama. Kuigi see ei mõjuta väljundit, muudab laiendus ressursi lugemise raskemaks. Samuti muudab see ressursi vähem paindlikuks, rikkudes selle, kui laiendus tulevikus muutub.
Hea nimetus:
https://example.com/api/books.xmlHalb nimetus:
https://example.com/api/books7. Kaasa versioonimine
Peaksite alati oma API lõpp-punktid nimetama vastavalt versioonile. See on oluline, kui teete API-s suuri muudatusi. See aitab eristada kahte või enamat API versiooni, kust ressurss pärineb. Versiooni saate näidata lõpp-punkti alguses.
Näiteks:
https://example.com/api/v3/booksMiks kaaluda API parimaid tavasid?
API-dest on saanud kaasaegse programmeerimise selgroog. Need parandavad koostööd, julgustavad uuendusi ja parandavad rakenduste turvalisust.
Olenemata sellest, kas kasutate uusi tööriistu või hallate olemasolevaid, lihtsustavad API-d protsessi. Seega on oluline omada lõpp-punkte, mis parandavad kasutajakogemust. API lõpp-punktide nimed ja struktuur määravad teie API jõudluse.
Kasutage tõhusate API lõpp-punktide loomiseks kindlasti parimaid tavasid.
