АПИ крајња тачка је тачка везе између два софтверска програма. АПИ-ји имају крајње тачке за сваки ресурс. Крајње тачке одређују тачну локацију ресурса на серверу.
Када клијентска апликација захтева информације од сервера, она пролази кроз АПИ. Који затим приступа захтеву и обрађује одговор са сервера. АПИ затим преноси тражене информације са крајње тачке на апликацију.
Ваш АПИ је ефикасан ако може ефикасно да комуницира преко својих крајњих тачака. Корисницима олакшава приступ ресурсима, побољшавајући корисничко искуство.
Како функционише АПИ крајња тачка?
Интегрисани системи комуницирају преко АПИ-ја. Један систем шаље захтев АПИ-ју, користећи формат као што је СОАП или РЕСТ. Сервер прима захтеве и преноси одговор назад у АПИ. Локација тог захтеваног ресурса је крајња тачка.
Пре него што крајња тачка обради захтев, клијент мора да обезбеди УРЛ, заглавља и тело. Заглавља садрже метаподатке о захтеву и податке о телу који се шаљу на сервер. Сервер се такође може повезати са базом података која
АПИ методе може приступити.Крајње тачке АПИ-ја обично раде са ХТТП методама као што су ГЕТ, ДЕЛЕТЕ, ПАТЦХ или ПОСТ. Методе одређују како се користи крајња тачка. Када клијент пошаље захтев, мора да га формулише тако да укључи метод захтева као и УРЛ, на пример:
ДОБИТИ https://example.com/books/authorsИменовање је тешко, било да се ради о крајњим тачкама АПИ-ја, умрежени хардверски уређаји, или функције и променљиве. Требало би да научите о неким најбољим праксама које можете да користите да бисте били сигурни да су крајње тачке АПИ-ја предност.
1. Користите косу црту унапред
Увек користите косе црте за раздвајање УРИ ресурса. Косе црте такође помажу да се прикаже хијерархија ресурса. Следи пример:
https://example.com/books/authors2. Користите именице, а не глаголе
За именовање ресурса треба да користите само именице. Именице описују чему служи ресурс за разлику од глагола који описује шта ресурс ради. Ево примера доброг и лошег начина за именовање крајњих тачака АПИ-ја.
Добро именовање:
https://example.com/api/getBooksЛоше именовање:
http://example.com/api/books3. Користите именице у множини, а не у једнини
Своје АПИ крајње тачке увек треба да именујете у множини именица. Ово указује кориснику да постоји више од једног ресурса на серверу. Употреба именице у једнини може збунити корисника да помисли да постоји само један ресурс.
Добро именовање:
https://example.com/api/book/3Лоше именовање:
http://example.com/api/books/34. Користите мала слова
Требало би да унесете све УРЛ-ове малим словима. Ово укључује УРЛ-ове крајњих тачака АПИ-ја. Ево примера:
Добро именовање:
http://example.com/api/Books/3Лоше именовање:
http://example.com/api/books/35. Користите цртице за раздвајање речи
Користите цртице да одвојите комбиноване речи. Цртице резултирају читљивијим фразама од великих слова или доњих црта. Такође су бољи за СЕО сврхе.
Добро именовање:
https://example.com/api/books/33/front_coverЛоше именовање:
https://example.com/api/books/33/front-cover6. Немојте додавати екстензије датотека
Не морате да додајете екстензију датотеке вашим крајњим тачкама АПИ-ја. Иако не утиче на излаз, проширење отежава читање ресурса. Такође чини ресурс мање флексибилним, разбијајући га ако се проширење промени у будућности.
Добро именовање:
https://example.com/api/books.xmlЛоше именовање:
https://example.com/api/books7. Инцлуде Версионинг
Увек треба да именујете крајње тачке АПИ-ја према верзији. Ово је важно ако правите велике промене у АПИ-ју. Помаже да се направи разлика између две или више верзија АПИ-ја одакле ресурс долази. Можете навести верзију на почетку крајње тачке.
На пример:
https://example.com/api/v3/booksЗашто узети у обзир најбоље праксе АПИ-ја?
АПИ-ји су постали окосница модерног програмирања. Они побољшавају сарадњу, подстичу иновације и побољшавају безбедност апликација.
Било да користите нове алате или управљате постојећим, АПИ-ји поједностављују процес. Зато је неопходно имати крајње тачке које побољшавају корисничко искуство. Именовање и структура ваших крајњих тачака АПИ-ја одређују перформансе вашег АПИ-ја.
Уверите се да користите најбоље праксе за креирање ефикасних АПИ крајњих тачака.