Tokie skaitytojai kaip jūs padeda palaikyti MUO. Kai perkate naudodami nuorodas mūsų svetainėje, galime uždirbti filialų komisinius. Skaityti daugiau.

API galinis taškas yra dviejų programinės įrangos programų ryšio taškas. API turi kiekvieno šaltinio galinius taškus. Galiniai taškai nurodo tikslią resurso vietą serveryje.

Kai kliento programa prašo informacijos iš serverio, ji eina per API. Tada ji pasiekia užklausą ir apdoroja atsakymą iš serverio. Tada API perkelia prašomą informaciją iš galutinio taško į programą.

Jūsų API yra efektyvi, jei ji gali efektyviai bendrauti per savo galinius taškus. Tai leidžia vartotojams lengviau pasiekti išteklius ir pagerina vartotojo patirtį.

Kaip veikia API galutinis taškas?

Integruotos sistemos bendrauja per API. Viena sistema siunčia užklausą API, naudodama formatu, pvz., SOAP arba REST. Serveris gauna užklausas ir perduoda atsakymą atgal į API. To prašomo šaltinio vieta yra galutinis taškas.

Prieš galutiniam taškui apdorodamas užklausą, klientas turi pateikti URL, antraštes ir turinį. Antraštėse yra metaduomenys apie užklausą ir į serverį siunčiami kūno detalių duomenys. Serveris taip pat gali prisijungti prie duomenų bazės, kuri

instagram viewer
API metodai gali prieiti.

API galiniai taškai paprastai veikia su HTTP metodais, tokiais kaip GET, DELETE, PATCH arba POST. Metodai nustato, kaip naudoti galutinį tašką. Kai klientas siunčia užklausą, jis turi ją suformuluoti, kad įtrauktų užklausos metodą ir URL, pavyzdžiui:

GAUTI https://example.com/books/authors

Sunku suteikti pavadinimus, nesvarbu, ar tai API galiniai taškai, tinklo aparatūros įrenginiai, arba funkcijos ir kintamieji. Turėtumėte sužinoti apie kai kurias geriausios praktikos pavyzdžius, kuriuos galite naudoti norėdami užtikrinti, kad jūsų API galutiniai taškai yra turtas.

1. Naudokite pasvirąjį brūkšnį

Visada naudokite pasviruosius brūkšnius, kad atskirtumėte URI išteklius. Pasvirieji brūkšniai taip pat padeda parodyti išteklių hierarchiją. Toliau pateikiamas pavyzdys:

https://example.com/books/authors

2. Naudokite daiktavardžius, o ne veiksmažodžius

Ištekliams pavadinti turėtumėte naudoti tik daiktavardžius. Daiktavardžiai apibūdina, kam skirtas išteklius, o ne veiksmažodis, apibūdinantis, ką išteklius daro. Čia yra gero ir blogo būdo pavadinti API galutinius taškus pavyzdys.

Geras pavadinimas:

https://example.com/api/getBooks

Netinkamas pavadinimas:

http://example.com/api/books

3. Naudokite daugiskaitos daiktavardžius, o ne vienaskaitą

API galutinius taškus visada turėtumėte pavadinti daugiskaitos daiktavardžiais. Tai vartotojui rodo, kad serveryje yra daugiau nei vienas išteklius. Vienaskaitos daiktavardžio naudojimas gali suklaidinti vartotoją ir manyti, kad yra tik vienas šaltinis.

Geras pavadinimas:

https://example.com/api/book/3

Netinkamas pavadinimas:

http://example.com/api/books/3

4. Naudokite mažąsias raides

Visus URL turėtumėte įvesti mažosiomis raidėmis. Tai apima API galutinio taško URL. Štai pavyzdys:

Geras pavadinimas:

http://example.com/api/Books/3

Netinkamas pavadinimas:

http://example.com/api/books/3

5. Žodžiams atskirti naudokite brūkšnelius

Norėdami atskirti sujungtus žodžius, naudokite brūkšnelius. Dėl brūkšnelių frazės yra lengviau įskaitomos nei kupranugarių didžiosios raidės ar apatiniai brūkšniai. Jie taip pat geresni SEO tikslais.

Geras pavadinimas:

https://example.com/api/books/33/front_cover

Netinkamas pavadinimas:

https://example.com/api/books/33/front-cover

6. Nepridėkite failų plėtinių

Jums nereikia pridėti failo plėtinio prie API galinių taškų. Nors tai neturi įtakos išvesties, plėtinys apsunkina šaltinio skaitymą. Dėl to išteklius taip pat tampa mažiau lankstus ir sulaužomas, jei plėtinys ateityje pasikeis.

Geras pavadinimas:

https://example.com/api/books.xml

Netinkamas pavadinimas:

https://example.com/api/books

7. Įtraukti versijas

Visada turėtumėte pavadinti API galinius taškus pagal versiją. Tai svarbu, jei atliekate esminius API pakeitimus. Tai padeda atskirti dvi ar daugiau API versijų, iš kurių gaunamas šaltinis. Versiją galite nurodyti pabaigos taško pradžioje.

Pavyzdžiui:

https://example.com/api/v3/books

Kodėl verta apsvarstyti API geriausią praktiką?

API tapo šiuolaikinio programavimo pagrindu. Jie pagerina bendradarbiavimą, skatina naujoves ir pagerina programų saugumą.

Nesvarbu, ar naudojate naujus įrankius, ar valdote esamus, API supaprastina procesą. Taigi labai svarbu turėti galutinius taškus, kurie pagerintų vartotojo patirtį. API galinių taškų pavadinimai ir struktūra lemia jūsų API našumą.

Įsitikinkite, kad naudojate geriausią praktiką kurdami efektyvius API galutinius taškus.