Водич за АПИ за одмор: РЕСТ АПИ архитектура и ограничења

rest api tutorial rest api architecture

У овом упутству ћемо научити о РЕСТ АПИ-ју, веб услугама, архитектури РЕСТ АПИ-ја, ограничењима РЕСТ АПИ-ја и како тестирати АПИ помоћу ПОСТМАН-а:

Предуслови: Основно знање о веб услугама.

Проверавати овде да бисте стекли јасно разумевање веб услуга.

Шта ћете научити:

• Шта је РЕСТ АПИ?
  • Разлика између САПУНА И ОСТАЛОГ
  • Зашто одабрати ОДМОР ОД САПУНА?
    • Зашто поштар?
  • РЕСТ АПИ Архитектура
  • Ограничења АПИ-ја РЕСТ
  • Шта је ПОШТАН?
  • Како тестирати АПИ са поштаром?
    • Инсталација
• Закључак
  • Препоручено читање

Шта је РЕСТ АПИ?

АПИ је једноставно интерфејс који софтверске компоненте користе за међусобну комуникацију. Услуга је функција која је добро дефинисана, самостална и не зависи од било које друге услуге.

Веб услуга је врста АПИ-ја, готово сви они раде преко ХТТП-а. Када се Веб АПИ развије помоћу РЕСТ архитектуре, тада се назива РЕСТ Веб АПИ.

За сада постоје две врсте веб услуга,

• САПУН
• ОСТАЛО

Разлика између САПУНА И ОСТАЛОГ

Зашто одабрати ОДМОР ОД САПУНА?

Испод тачке објашњавају се разлози за одабир РЕСТ преко СОАП-а.

• Веома је добар за развој и тестирање веб АПИ-ја.
• РЕСТ захтева мању ширину опсега.
• АЈАКС можемо користити за веб АПИ-је засноване на РЕСТ-у.
• То захтева мање рашчлањивање трошкова.
• Величина корисног терета коју је креирао ЈСОН је мање величине.

На мрежи је доступно много клијената / алата, што нам омогућава да користимо РЕСТфул веб услуге.

Су:

• Поштар
• Клијент за напредни одмор
• ДХЦ Рест клијент
• Подносилац захтева
• Несаница
• Утврдиво
• Плакат

Зашто поштар?

• Приказује све доступне опције.
• Поштар има додатну функцију (познату као Тркач).
• Кориснички прилагођен кориснички интерфејс и једноставан за употребу.
• Већа група / чланови заједнице.

РЕСТ АПИ Архитектура

То је углавном архитектура Веба у софтверском архитектонском стилу. Намењен је дистрибуираним хипермедијским системима. АПИ РЕСТфул директно користи предности ХТТП методологија дефинисаних протоколом РФЦ 2616.

Неколико дефиниција

ВАТРА је скраћеница од Апплицатион Программинг Интерфаце. То је скуп дефиниција потпрограма, протокола и алата за изградњу апликативног софтвера.

Веб сервиси су неки програмски кодови који садрже податке / уграђене методе. Организација их распоређује путем Интернета за комуникацију са корисницима, независним апликацијама итд. За комуникацију порука, углавном се КСМЛ користи као систем за размену порука. КСМЛ једноставно кодира сву комуникацију између корисника и апликација.

ХТТП означава протокол за пренос хипертекста који користи Ворлд Виде Веб. Дефинише како се поруке форматирају и преносе и које акције веб сервери и прегледачи предузимају као одговор на разне наредбе.

Архитектонски стил, њих карактеришу особине које се користе за стварање структуре, па чак и стварање јединствене. Стилови су две врсте: Слојевити и Униформ интерфејс.

МРЖЊА : Такође познат као јединствени идентификатор ресурса. Идентификује ресурс (текстуални документ, сликовну датотеку итд.).
УРЛ: Такође познат као Униформ Ресоурце Лоцатор. То је подскуп УРИ-ја, који укључује мрежну локацију.
УРН : Такође познато као једнообразно име ресурса је подскуп УРИ-ја, који укључују име унутар датог простора, али не и локацију.

На пример,

хттп://елеарнинг.цом/амазон/рестапи.хтмл#боокс

Ево, у горњем примеру

МРЖЊА : хттп://елеарнинг.цом/амазон/рестапи.хтмл#постс
УРЛ : хттп://елеарнинг.цом/амазон/рестапи.хтмл
УРН : елеарнинг.цом/амазон/рестапи.хтмл#постс

најбољи бесплатни софтвер за подешавање рачунара

Отуда је УРЛ УРИ који идентификује ресурс и такође пружа средства за проналажење ресурса описујући начин приступа.

Дакле, свака УРЛ адреса може бити УРИ, али обрнуто није тачно.

Услуга РЕСТфул се излаже путем јединственог локатора ресурса (УРЛ). Ово је логично име које раздваја идентитет ресурса од онога што је прихваћено или враћено.

Пример РЕСТ архитектуре:

Ограничења АПИ-ја РЕСТ

За АПИ интерфејс се каже да је РЕСТфул ако испуњава следећа ограничења:

• Униформ Интерфаце: Значи, без обзира на било ког клијента којег користимо, основни концепт примене и коришћења РЕСТ услуга остаће исти. Сви развијени РЕСТ АПИ-и треба да имају заједнички приступ развоју.
• Без држављанства: То значи да ниједна сесија неће бити сачувана. Дакле, сервер неће чувати ниједан ХТТП захтев који је послао клијент. Стога је за сервер сваки ХТТП захтев нови захтев. Без обзира на то колико се пута захтева или је купац јединствен или не.
• Могућност кеширања: Кеширање значи како се честим подацима и одговорима приступа из кеш меморије уместо са сервера. Концепт кеширања је применљив током слања захтева клијента. Дакле, побољшање перформанси се врши на страни клијента.
• Клијент-сервер: Сервер и клијенти су независни једни од других у погледу примене. Клијент треба само да пошаље УРИ захтева заједно са или без потврде идентитета. Тада сервер преузима остатак корака, то је одговор.
• Слојевити систем: Клијент серверу може послати само захтев као УРИ ресурса. Али онда, пре него што се захтев пошаље на сервер, постоји РЕСТ АПИ, који нам пружа слојевиту системску архитектуру. То значи да АПИ можемо распоређивати на једном серверу, податке на другом серверу и аутентификацију на другом серверу.
• Код на захтев (опционално): Понекад клијенту треба више од самог одговора. РЕСТ АПИ омогућава нам да као одговор пошаљемо извршни код (овај извршни код може бити виџет или било која контрола). Међутим, потпуно је необавезно да ли смо омогућили / применили ову функцију.

Још неколико терминологија повезаних са Рест АПИ:

Крајња тачка : То је референца на УРЛ адресу која прихвата веб захтеве. Веб услузи је могуће адресирати помоћу референце крајње тачке.
На пример, Хттп: // {Домаин_УРЛ} //либраригр/либрариес.кмл

Ресурси : То је подскуп Крајње тачке. Крајње тачке обично излажу неке предмете који се могу потрошити путем веб услуга. Ресурси су посебно онај део објекта преко УРИ-ја крајње тачке.
На пример, Хттп: // {Домаин_УРЛ} // апи / пг_либрари / орнитхологи / сван

Носивост : Корисни терет је информација која се шаље током извођења ПОСТ или ПУТ операција. То су информације наведене у телу ХТТП захтева.

Корисни терети се шаљу у ЈСОН формату, На пример,

Параметри :

Параметре можемо преносити на два начина.

Параметри упита : Корисно за приступ паровима кључ / вредност у низу упита УРЛ-а (део иза?)

Најбољи пример

хттп://јсонплацехолдер.типицоде.цом/постс/?ид=3

Параметри путање: Корисно је подударати део УРЛ-а као параметар. Информације можемо послати као параметар пута на следећи начин: Подаци обрасца, к-ввв-форм-урленцодед, сирови, бинарни.

Најбољи пример:

хттпс://апи.гитхуб.цом/гистс/49б05378бб8920д5б4ец54ефц27103е2/цомментс

Шта је ПОШТАН?

ПОСТМАН је ОСТАЛИ клијент, једноставно апликација која долази са Цхроме прегледачем. Развија се, имајући на уму програмерима да олакшају тестирање АПИ позива. Има свој ГУИ за слање АПИ захтева и читање АПИ одговора.

Тестирање АПИ-ја РЕСТ можемо обавити како ручно, тако и аутоматизацијом.

У следећем одељку ћемо научити како ручно тестирати Веб АПИ помоћу ПОСТМАН клијента.

Како тестирати АПИ са поштаром?

Инсталација

Морамо да приступимо Цхроме веб продавница . У претраживачу Цхроме потражите Поштара. Кликните овде да бисте га додали на Цхроме дугме.

Када се успешно инсталира, ПОСТМАН можемо пронаћи у апликацији Цхроме. Само кликните икону Поштар да бисте отворили ПОСТМАН. Биће потребно време да се покрене први пут.

Погледајте следећу УРЛ адресу да бисте разумели како се користи ПОШТАР као алат.

најбољи софтвер за праћење температуре процесора

Предуслови: Интернет веза је потребна за приступ услугама распоређеним преко веба. У случају приступа локално распоређеним услугама, уверите се да се дају довољна права и привилегије кориснику који извршава тест преко ПОСТМАН-а.

Умијски УРИ ресурса: У овом упутству ћемо користити лажни УРИ уместо правог УРИ-ја. Даће нам одговоре по жељи, али на серверу се не могу вршити промене.

хттп://јсонплацехолдер.типицоде.цом

Кораци за навигацију :

# 1) Када се покрене апликација ПОСТМАН, подразумевано можемо видети страницу Захтев.

#два) Списак АПИ позива можемо видети кликом на падајући мени. Одабиром било које од опција са падајућег менија можемо захтевати АПИ позив серверу.

# 3) Кликните на дугме променљиве окружења у горњем десном углу ПОШТАЊА. Поставите одређено окружење, где ћемо тестирати. Можемо га сачувати за будуће извршење.

# 4) Сачуваном окружењу можете приступити из падајућег менија Околина.

# 5) Даље, треба да поставимо УРИ ресурса у дато поље.

# 6) Кликните на дугме Парамс поред поља Ресоурце УРИ да бисте одредили параметре упита

# 7) Кликните на картицу Ауторизација, са падајућег менија одаберите врсту ауторизације и поставите било коју жељену ауторизацију или је можете једноставно оставити као Без ауторизације.

# 8) Кликните картицу Заглавља и поставите потребна заглавља попут типа садржаја

# 9) Кликните картицу Боди, одаберите радио дугме за податке о обрасцу. Наведите потребне параметре тела које треба послати заједно са УРЛ-ом захтева

# 10) Кликните картицу Боди, изаберите радио дугме к-ввв-форм-урленцодед. Наведите потребне параметре тела које треба послати кодирано, заједно са УРЛ-ом захтева

#Једанаест) Кликните картицу Боди, изаберите радио дугме „рав“. Наведите потребне параметре тела које треба послати заједно са УРЛ-ом захтева. Ово је у стварном ЈСОН формату

# 12) Кликните картицу Боди, изаберите радио дугме „бинарно“. Наведите потребне параметре тела (обично као датотеку) које треба послати заједно са УРЛ-ом захтева.

# 13) Након што смо конфигурисали све детаље како је горе наведено, сада можемо да ’пошаљемо’ захтев. Такође, захтев за слање можемо сачувати као рекуест.јсон (можемо променити име захтева).

# 14) Списак поднетих захтева можемо видети на левој бочној плочи испод картице Историја.

# петнаест) Такође, све детаље везане за захтев (УРИ, ауторизација, параметри, тело итд.) Можемо сачувати у постојећој колекцији или новој колекцији. Једном када је захтев додан у колекцију, можемо га извести (делити), па чак и увести било коју постојећу колекцију.

како инсталирати мавен у ецлипсе

Збирку можемо делити као везу или као тимску библиотеку помоћу једноставног генерисаног кода. Увек можемо покренути читав пакет збирки.

Чак и ми можемо објавити УРЛ колекције на вебу, тако да свако ко приступа објављеном УРЛ-у може приступити колекцији и користити услуге које пружа Веб АПИ.

Постоји функција за пријављивање на ПОСТМАН, која нам омогућава да складиштимо историју, колекције, податке о животној средини, локално складиште тако да их можемо сачувати и приступити им било где, било када, након што смо пријављени на ПОСТМАН.

Тркач

Користи се за покретање ресурса присутних у фасцикли Збирке.

Закључак

Већина компанија усваја РЕСТ архитектонски стил за развој / имплементацију веб услуга, јер је то једноставан и усер-фриендли интерфејс, који захтева мање обуке за постојеће / нове чланове пројекта. Организације разматрају РЕСТ заједно са својим постојећим веб услугама.

Такође прочитајте = >> Водич за Фласк АПИ

У следећем упутству, ове РЕСТ АПИ серије, разговараћемо о различитим врстама кодова одговора, типовима РЕСТ захтева итд.

Препоручено читање

• Кодови одговора на АПИ за одмор и врсте захтева за одмор
• Водич за ПОСТМАН: Испитивање АПИ-ја помоћу ПОСТМАН-а
• РЕСТ АПИ тестирање са краставцем применом БДД приступа
• 10 најбољих алата за тестирање АПИ-ја у 2021. години (СОАП и РЕСТ АПИ алати за тестирање)
• РЕСТ АПИ тестирање помоћу Спринг РестТемплате и ТестНГ
• Како аутоматизовати захтеве за АПИ помоћу „Будите сигурни“ и Јенкинс
• Како створити РЕСТ пројекат у СоапУИ Про: Водич бр. 13
• Водич за Парасофт СОАтест: Алат за тестирање АПИ-ја без скрипти