АПИ-ји све више обликују технолошки екосистем. Скоро све модерне апликације сада имају АПИ крајњу тачку са којом можете да комуницирате.
АПИ-ји раде као посредници, омогућавајући вам да изградите програмске интеракције између апликација које људи и предузећа свакодневно користе.
Међутим, нису сви АПИ-ји погодни за интеграцију и употребу. Ужасни АПИ-ји који фрустрирају кориснике постоје. Следе смернице које можете користити да идентификујете АПИ који одговара вашим развојним потребама.
1. Оптимизовано АПИ време позива
Оптимизирање АПИ позиви укључује смањење времена одговора АПИ-ја. Ово укључује брзину којом АПИ служи захтеве и шаље одговоре. Такође укључује смањење утицаја који велике количине података имају на брзину АПИ-ја.
Време одговора АПИ-ја утиче на корисничко искуство. Спори АПИ-ји фрустрирају корисника и утичу на перформансе апликације. АПИ са високим учинком треба да има време одговора мање од једне секунде.
Као програмер, можете тестирати брзину било ког АПИ-ја који користи Цхроме ДевТоолс. Отвори Алатке за програмере > Мрежа, а затим приступите АПИ крајњој тачки у свом претраживачу.
Видећете анализу перформанси АПИ-ја на основу статуса, типа, величине и времена. Време мери брзину АПИ-ја.
Можете ићи даље и анализирати компоненте АПИ-ја на истој картици. Кликните на крајњу тачку. Видећете отворену картицу са информацијама о његовим компонентама. Ово укључује детаље о Заглавља, Одговор, и Тајминг.
Сада можете рећи да ли је АПИ довољно брз за вашу апликацију. Постоје и други онлајн алати које можете користити тест за брзину АПИ-ја. Популарни међу програмерима су Поштар и Сваггер.
2. Има водиче за укључивање
Добар АПИ пружа смернице за укључивање корисницима. Водич за укључивање би требало да вас упозна са садржајем АПИ-ја. Објашњава случајеве употребе АПИ-ја и како их интегрисати. Информације могу укључивати дефиниције крајње тачке, исечке кода и примере одговора.
РапидАПИ-јев водич за укључивање је добар пример. Водич има све што корисници треба да знају да би користили своје АПИ-је.
Водичи за укључивање такође треба да садрже информације о аутентификацији. Неопходно је да имате добро документован процес аутентификације како бисте лако могли да почнете да радите са АПИ-јем.
АПИ-ји користе различите начине за аутентификацију својих корисника. Најчешћи је коришћење АПИ кључа. Сваки регистровани корисник добија АПИ кључ који користи за упућивање позива. АПИ може имати различите кључеве за аутентификацију за различите категорије корисника.
3. Има јасну и концизну документацију
Сав технички садржај треба да буде јасан и концизан. Јасноћа је посебно важна за АПИ-је. Као програмер, немате времена да пролазите кроз превише документације, па потражите АПИ-је који олакшавају учење како да их користите.
Документација осигурава да ће корисници имати добро корисничко искуство. Искуство је кључно за повећање усвајања АПИ-ја. Добро структурирана документација описује крајње тачке, методе и опције одговора.
Добра документација има на уму кориснике. То су људи који немају знања о АПИ-ју. Стога, све информације треба да користе познате речи и фразе.
Документација треба да садржи корак по корак примере и илустрације. Ово вам помаже да брзо разумете концепте. Испод је пример добро структуиране документације из Твилио вебсите.
Документација АПИ-ја треба да прати строге смернице. Добар пример водича за АПИ документацију је Том Џонсон Радије бих писао Водич. То је комплетан водич о томе како структурирати и писати АПИ документацију.
4. Има интерактивну конзолу
Добар АПИ има конзолу на којој можете тестирати АПИ. Тестирање крајњих тачака АПИ-ја вам омогућава да видите да ли одговара вашим захтевима.
Интерактивне конзоле стварају игралиште за брзо тестирање крајњих тачака. Ово је предност јер значи да не морате да користите друге алате за тестирање. Конзоле су добар начин да се утврди да ли АПИ одговара вашим развојним потребама.
Веб локација РапидАПИ има добар пример интерактивне конзоле коју можете користити за тестирање случајева употребе АПИ-ја.
5. Пружа опције коришћења
АПИ документација треба да буде јасно да ли је бесплатна или не. Морате бити свесни који су планови бесплатни, а који захтевају плаћање. Избегавајте компликоване планове цена и оне са многим ограничењима.
Добри АПИ-ји имају више планова за пружање услуга различитим клијентима. Информације треба да буду отворене о квотама коришћења и ограничењима која долазе са сваким планом. РапидАПИ има јасан план цена који укључује основне бесплатне и плаћене планове компаније за своје кориснике.
6. Има водиче и упутства
Упутства помажу корисницима да разумеју како АПИ функционише. Они уче почетника како да практично користе АПИ. Ако пратите један, требало би да разумете шта можете да очекујете када будете у интеракцији са АПИ-јем.
Циљ туторијала је да вас води да произведете најједноставнији могући излаз са системом. Упутство за АПИ може бити одговор на захтев направљен на АПИ-ју. Показује вам како да користите језик или оквир да бисте добили одређени одговор.
Туторијали треба да садрже упутства о томе како да се пријавите за налог и генерише АПИ кључеве. Поред тога, требало би да постоје упутства о томе како послати захтев и проверити одговор. Добар водич ће такође имати илустрације као што су дијаграми, инфографике и аудио-визуелне слике. Ово олакшава разумевање укључених процеса.
Пример АПИ-ја са добрим илустрацијама је АсинцАПИ иницијатива.
Претпоставка је да ако позовете један случај употребе користећи туторијал, успећете да упутите друге позиве. Добра је идеја да проверите да ли су туторијали тачни.
Зашто би требало да користите ове смернице за АПИ
АПИ-ји стварају могућности за интеракцију са апликацијама широм света. Препознавање доброг ће уштедети време које бисте потрошили на креирање функције од нуле.
АПИ-ји вам дају приступ апликацијама светске класе са невероватним функцијама. Да бисте добили добар АПИ, морате узети у обзир аспекте АПИ-ја који превазилазе крајње тачке и методе позива.
Добар АПИ је брз и добро документован да инспирише програмере на интеракцију са њим. Пратите горње смернице и изаберите најбољи АПИ за своју апликацију.
