Што такое API і што трэба ўлічваць пры распрацоўцы API?
API (інтэрфейс прыкладнога праграмавання) - гэта набор інструкцый, стандартаў або патрабаванняў, якія дазваляюць праграмнаму забеспячэнню або праграме выкарыстоўваць функцыі або паслугі іншай праграмы, платформы або прылады для паляпшэння паслуг. Карацей кажучы, гэта тое, што дазваляе праграмам мець зносіны адзін з адным.
API з'яўляецца асновай для ўсіх прыкладанняў, якія працуюць з дадзенымі або забяспечваюць сувязь паміж двума прадуктамі або паслугамі. Гэта дазваляе мабільнаму прылажэнню або платформе дзяліцца сваімі дадзенымі з іншымі прылажэннямі/платформамі і палягчае працу карыстальніка без удзелу распрацоўшчыкаў.
Акрамя таго, API пазбаўляюць ад неабходнасці ствараць параўнальную платформу або праграмнае забеспячэнне з нуля. Вы можаце выкарыстоўваць бягучую тую ці іншую платформу або дадатак. Па гэтых прычынах працэс распрацоўкі API знаходзіцца ў цэнтры ўвагі як распрацоўшчыкаў прыкладанняў, так і кіраўнікоў кампаній.
Праца API
Выкажам здагадку, што вы адкрылі праграму або вэб-сайт XYZ, каб забраніраваць рэйс. Вы запоўнілі форму, уключылі час адпраўлення і прыбыцця, горад, інфармацыю аб рэйсах і іншую неабходную інфармацыю, а затым адправілі яе. За долю секунды на экране з'явіцца спіс рэйсаў разам з коштам, раскладам, наяўнасцю месцаў і іншымі падрабязнасцямі. Як гэта насамрэч адбываецца?
Для прадастаўлення такіх строгіх даных платформа накіравала запыт на сайт авіякампаніі для доступу да іх базы дадзеных і атрымання адпаведных даных праз інтэрфейс прыкладной праграмы. Вэб-сайт адказаў данымі, якія API Integration даставіў на платформу, і платформа паказала іх на экране.
Тут праграма/платформа для браніравання рэйсаў і вэб-сайт авіякампаніі выступаюць у якасці канчатковых кропак, а API з'яўляецца прамежкавым звяном, які ўпарадкоўвае працэс абмену дадзенымі. Калі казаць аб перадачы канчатковых кропак, API працуе двума спосабамі, а менавіта: REST (перадача стану прадстаўлення) і SOAP (пратакол простага доступу да аб'ектаў).
Хоць абодва метаду прыносяць эфектыўныя вынікі, a кампанія па распрацоўцы мабільных прыкладанняў аддае перавагу REST перад SOAP, паколькі SOAP API цяжкія і залежаць ад платформы.
Каб падрабязна зразумець жыццёвы цыкл API і ведаць, ці працуе API, звяжыцеся з нашымі экспертамі сёння!
Інструменты для распрацоўкі API
Нягледзячы на тое, што існуе мноства інструментаў і тэхналогій праектавання API, уключаных у працэс стварэння API, папулярныя тэхналогіі распрацоўкі API і інструменты для распрацоўкі API для распрацоўшчыкаў:
- Апігей
Гэта пастаўшчык кіравання API Google, які дапамагае распрацоўшчыкам і прадпрымальнікам перамагчы ў лічбавай трансфармацыі шляхам аднаўлення падыходу інтэграцыі API.
- APIMatic і API Transformer
Гэта іншыя папулярныя інструменты для распрацоўкі API. Яны прапануюць складаныя інструменты аўтаматычнай генерацыі для стварэння высакаякасных SDK і фрагментаў кода са спецыфічных для API фарматаў і пераўтварэння іх у іншыя спецыфікацыі, такія як RAML, API Blueprint і г.д.
- API навукі
Гэты інструмент у асноўным выкарыстоўваецца для ацэнкі прадукцыйнасці як унутраных API, так і знешніх API.
- Бессерверная архітэктура API
Гэтыя прадукты дапамагаюць распрацоўшчыкам мабільных праграм у распрацоўцы, стварэнні, публікацыі і размяшчэнні API з дапамогай воблачнай сервернай інфраструктуры.
- API-платформа
Гэта адзін з фрэймворкаў PHP з адкрытым зыходным кодам, прыдатны для распрацоўкі вэб-API.
- Аўт0
Гэта рашэнне для кіравання ідэнтыфікацыяй, якое выкарыстоўваецца для аўтэнтыфікацыі і аўтарызацыі API.
- ClearBlade
Гэта пастаўшчык кіравання API для ўкаранення тэхналогіі IoT у ваш працэс.
- GitHub
Гэта паслуга размяшчэння сховішча git з адкрытым зыходным кодам дазваляе распрацоўшчыкам кіраваць файламі кода, запытамі на выцягванне, кантролем версій і каментарыямі, якія размеркаваны па групе. Гэта таксама дазваляе ім захоўваць свой код у прыватных сховішчах.
- Паштальён
Па сутнасці, гэта набор інструментаў API, які дазваляе распрацоўшчыкам запускаць, тэставаць, дакументаваць і ацэньваць прадукцыйнасць свайго API.
- Плывучы
Гэта структура з адкрытым зыходным кодам, якая выкарыстоўваецца для распрацоўкі праграмнага забеспячэння API. Вялікія тэхналагічныя гіганты, такія як GettyImages і Microsoft, выкарыстоўваюць Swagger. Нягледзячы на тое, што свет поўны API, усё яшчэ існуе вялікі прабел у выкарыстанні пераваг тэхналогіі API. У той час як некаторыя API робяць інтэграцыю ў дадатак простай справай, іншыя ператвараюць яе ў кашмар.
Абавязковыя функцыі эфектыўнага API
- Пазнакі часу змены або Пошук па крытэрыях
Самая галоўная асаблівасць API, якую павінна мець праграма, - гэта пазнакі часу змены/пошук па крытэрыях. API павінен дазваляць карыстальнікам шукаць даныя па розных крытэрыях, напрыклад, па даце. Гэта таму, што змены (абнаўленне, рэдагаванне і выдаленне) мы разглядаем адразу пасля першай пачатковай сінхранізацыі даных.
- пэйджынг
Шмат разоў здараецца, што мы не жадаем бачыць змененыя дадзеныя, а толькі іх пробліск. У такім выпадку API павінен мець магчымасць вызначаць, колькі даных адлюстроўваць за адзін раз і з якой частатой. Ён таксама павінен інфармаваць канчатковага карыстальніка аб не. старонак дадзеных, якія засталіся.
- сартаванне
Каб пераканацца, што канчатковы карыстальнік атрымлівае ўсе старонкі з данымі адну за адной, API павінен даць карыстальнікам магчымасць сартаваць даныя па часе мадыфікацыі або па іншых умовах.
- Падтрымка JSON або REST
Хоць гэта і не з'яўляецца абавязковым, для эфектыўнай распрацоўкі API добра лічыць, што ваш API падтрымлівае REST (або забяспечвае падтрымку JSON (REST)). API-інтэрфейсы REST не маюць статусу, палегчаны і дазваляюць паўтарыць працэс загрузкі мабільнай праграмы ў выпадку няўдачы. Гэта даволі складана ў выпадку SOAP. Акрамя таго, сінтаксіс JSON нагадвае сінтаксіс большасці моў праграмавання, што дазваляе распрацоўшчыкам мабільных дадаткаў лёгка перавесці яго на любую іншую мову.
- Аўтарызацыя праз OAuth
Зноў жа неабходна, каб інтэрфейс вашай прыкладной праграмы аўтарызаваўся праз OAuth, паколькі гэта хутчэй, чым іншыя метады, вам проста трэба націснуць кнопку, і ўсё гатова.
Карацей кажучы, час апрацоўкі павінен быць мінімальным, час водгуку добрым і ўзровень бяспекі высокім. Вельмі важна прыкласці намаганні да перадавых практык распрацоўкі API для забеспячэння бяспекі вашага прыкладання, у рэшце рэшт, яно мае справу з кучай даных.
Тэрміналогіі API
- Ключ API – Калі API правярае запыт праз параметр і разумее запытальнік. А аўтарызаваны код перадаецца ў ключ запыту і называецца КЛЮЧОМ API.
- Канчатковая кропка - калі API адной сістэмы ўзаемадзейнічае з іншай сістэмай, адзін канец канала сувязі называецца канчатковай кропкай.
- JSON – Аб'екты JSON або Javascript выкарыстоўваюцца ў якасці фармату даных, які выкарыстоўваецца для параметраў запыту API і цела адказу.
- GET – Выкарыстанне метаду HTTP API для атрымання рэсурсаў
- POST – гэта метад HTTP RESTful API для стварэння рэсурсаў.
- OAuth – гэта стандартная структура аўтарызацыі, якая забяспечвае доступ з боку карыстальніка без перадачы ўліковых даных.
- REST – Праграмаванне, якое павышае эфектыўнасць сувязі паміж двума прыладамі/сістэмамі. REST абагульвае толькі неабходныя даныя, а не поўныя даныя. Сістэмы, усталяваныя на гэтай архітэктуры, называюцца сістэмамі «RESTful», і самым яркім прыкладам сістэм RESTful з'яўляецца Сусветная павуціна.
- SOAP - SOAP або просты пратакол доступу да аб'ектаў - гэта пратакол абмену паведамленнямі для абмену структураванай інфармацыяй пры выкананні вэб-сэрвісаў у камп'ютэрных сетках.
- Затрымка - вызначаецца як агульны час, затрачаны працэсам распрацоўкі API ад запыту да адказу.
- Абмежаванне хуткасці - гэта азначае абмежаванне колькасці запытаў, якія карыстальнік можа накіраваць да API за адзін раз.
Лепшыя практыкі для стварэння правільнага API
- Выкарыстоўвайце Throttling
App Throttling - гэта выдатная практыка для перанакіравання перапаўнення трафіку, рэзервовага капіявання API і абароны ад нападаў DoS (адмова ў абслугоўванні).
- Разглядайце свой шлюз API як Enforcer
Падчас наладжвання правілаў рэгулявання, прымянення ключоў API або OAuth шлюз API павінен разглядацца як кропка выканання. Яго трэба ўспрымаць як паліцэйскі, які дазваляе толькі патрэбным карыстальнікам атрымаць доступ да дадзеных. Гэта павінна даць вам магчымасць шыфраваць паведамленне або рэдагаваць канфідэнцыяльную інфармацыю і, такім чынам, аналізаваць і кіраваць тым, як выкарыстоўваецца ваш API.
- Дазволіць перавызначэнне метаду HTTP
Паколькі некаторыя проксі падтрымліваюць толькі метады GET і POST, вам трэба дазволіць вашаму RESTful API перавызначыць метад HTTP. Для гэтага выкарыстоўвайце карыстальніцкі загаловак HTTP X-HTTP-Method-Override.
- Ацаніце API і інфраструктуру
У цяперашні час можна атрымаць аналіз у рэальным часе, але што, калі ёсць падазрэнні на ўцечку памяці на серверы API, разгрузку працэсара або іншыя падобныя праблемы? Для разгляду такіх сітуацый забудоўшчыка не трымаеш. Тым не менш, вы можаце зрабіць гэта лёгка з дапамогай шматлікіх інструментаў, даступных на рынку, такіх як AWS Cloud Watch.
- Забяспечце бяспеку
Вы павінны пераканацца, што ваша тэхналогія API бяспечная, але не за кошт зручнасці для карыстання. Калі любы карыстальнік марнуе больш за 5 хвілін на аўтэнтыфікацыю, гэта азначае, што ваш API далёка не зручны. Вы можаце выкарыстоўваць аўтэнтыфікацыю на аснове токенаў, каб зрабіць свой API бяспечным.
- дакументацыя
І апошняе, але не менш важнае: выгадна ствараць шырокую дакументацыю для API для мабільных прыкладанняў, якая дазваляе іншым распрацоўшчыкам мабільных прыкладанняў лёгка зразумець увесь працэс і выкарыстоўваць інфармацыю для лепшага карыстання. Іншымі словамі, добрая дакументацыя API у працэсе эфектыўнай распрацоўкі API скароціць час рэалізацыі праекта, кошт праекта і павысіць эфектыўнасць тэхналогіі API.