Výukový program Rest API: REST API Architecture and Constraints

rest api tutorial rest api architecture

V tomto výučbe sa dozvieme viac o rozhraní REST API, webových službách, architektúre rozhrania REST API, obmedzeniach rozhrania REST API a o tom, ako otestovať rozhranie API pomocou nástroja POSTMAN:

Predbežné požiadavky: Základné znalosti o webových službách.

Skontrolujte tu aby ste jasne pochopili webové služby.

Čo sa dozviete:

• Čo je to REST API?
  • Rozdiel medzi mydlom a odpočinkom
  • Prečo zvoliť REST Over SOAP?
    • Prečo Poštár?
  • Architektúra REST API
  • Obmedzenia REST API
  • Čo je POSTMAN?
  • Ako otestovať API s poštárom?
    • Inštalácia
• Záver
  • Odporúčané čítanie

Čo je to REST API?

API je jednoducho rozhranie, ktoré používajú softvérové ​​komponenty na vzájomnú komunikáciu. Služba je funkcia, ktorá je dobre definovaná, samostatná a nezávisí od žiadnych iných služieb.

Webová služba je typ API, takmer všetky fungujú cez HTTP. Keď sa webové rozhranie API vyvíja pomocou architektúry REST, potom sa nazýva webové rozhranie REST.

V súčasnosti existujú dva typy webových služieb,

• MYDLO
• ODDYCH

Rozdiel medzi mydlom a odpočinkom

Prečo zvoliť REST Over SOAP?

V nasledujúcich bodoch sú vysvetlené dôvody, prečo sa rozhodnúť pre REST over SOAP.

• Je to veľmi dobré na vývoj a testovanie webových rozhraní API.
• REST vyžaduje menšiu šírku pásma.
• Môžeme použiť AJAX pre webové API založené na REST.
• Vyžaduje to menšiu analýzu nad hlavou.
• Veľkosť užitočného zaťaženia vytvorená súborom JSON je menšej veľkosti.

Na webe je k dispozícii veľa klientov / nástrojov, čo nám umožňuje využívať služby RESTful Web.

Oni sú:

• Poštár
• Advanced Rest Client
• Klient DHC Rest
• Žiadateľ
• Nespavosť
• Priraditeľný
• Plagát

Prečo Poštár?

• Zobrazuje všetky dostupné možnosti.
• Poštár má ďalšiu funkciu (známu ako Runner).
• Užívateľsky prívetivé užívateľské rozhranie a jednoduché použitie.
• Väčšia komunitná skupina / členovia.

Architektúra REST API

Je to hlavne architektúra webu v softvérovom architektonickom štýle. Je určený pre distribuované hypermediálne systémy. Rozhranie RESTful API priamo využíva metodiky HTTP definované protokolom RFC 2616.

Niekoľko definícií

POŽIAR znamená Application Programming Interface. Je to súbor definícií podprogramov, protokolov a nástrojov na tvorbu aplikačného softvéru.

Webové služby sú niektoré programové kódy, ktoré obsahujú údaje / zabudované metódy. Tieto sú nasadené organizáciou cez internet na komunikáciu s používateľmi, aplikáciami tretích strán atď. Na komunikáciu so správami sa ako systém správ používa väčšinou XML. XML jednoducho kóduje všetku komunikáciu medzi používateľmi a aplikáciami.

HTTP znamená Hypertext Transfer Protocol používaný webovou sieťou. Definuje, ako sa správy formátujú a prenášajú a aké akcie vykonávajú webové servery a prehľadávače v reakcii na rôzne príkazy.

Architektonický štýl, vyznačujú sa vlastnosťami, ktoré sa používajú na vytvorenie štruktúry a dokonca ju robia jedinečnou. Štýly sú dvoch typov: vrstvené a jednotné rozhranie.

NENÁVIDIŤ : Známy tiež ako jednotný identifikátor zdroja. Identifikuje zdroj (textový dokument, obrazový súbor atď.).
URL: Tiež sa nazýva Uniform Resource Locator. Je to podmnožina identifikátorov URI, ktorá obsahuje sieťové umiestnenie.
URN : Uniform Resource Name je tiež podmnožina identifikátorov URI, ktoré obsahujú názov v danom priestore, ale nie umiestnenie.

Napríklad,

http://elearning.com/amazon/restapi.html#books

Tu vo vyššie uvedenom príklade

NENÁVIDIŤ : http://elearning.com/amazon/restapi.html#posts
URL : http://elearning.com/amazon/restapi.html
URN : elearning.com/amazon/restapi.html#posts

runtime polymorfizmus v c ++

Preto je URL URI, ktorý identifikuje zdroj a tiež poskytuje prostriedky na jeho lokalizáciu opísaním spôsobu prístupu k nemu.

Takže každá adresa URL môže byť URI, ale naopak nie je pravda.

Služba RESTful je sprístupnená prostredníctvom vyhľadávača Uniform Resource Locator (URL). Toto je logický názov, ktorý oddeľuje identitu prostriedku od toho, čo je prijaté alebo vrátené.

Ukážka architektúry REST:

Obmedzenia REST API

O rozhraní API sa hovorí, že je RESTful, ak spĺňa nasledujúce obmedzenia:

• Jednotné rozhranie: To znamená, bez ohľadu na ktoréhokoľvek klienta, ktorého používame, základná koncepcia implementácie a používania služieb REST zostane rovnaká. Všetky vyvinuté rozhrania REST API by mali mať spoločný prístup k vývoju.
• Bezstavový: To znamená, že sa nemá ukladať žiadna relácia. Server teda nebude ukladať žiadne požiadavky HTTP odoslané klientom. Pre server je teda každá požiadavka HTTP novou požiadavkou. Nezáleží na tom, koľkokrát je vznesená požiadavka alebo či je zákazník jedinečný.
• Uložené do medzipamäte: Ukladanie do pamäte cache znamená, ako často sa k údajom a odpovediam pristupuje z medzipamäte namiesto zo servera. Koncept ukladania do pamäte cache je použiteľný pri odosielaní žiadosti klienta. Zlepšenie výkonu sa teda deje na strane klienta.
• Klientsky server: Server a Klienti sú z hľadiska implementácie navzájom nezávislí. Klientovi stačí odoslať identifikátor URI požiadavky spolu s autentifikáciou alebo bez nej. Potom server vykoná zvyšok kroku, to je odpoveď.
• Vrstvený systém: Klient môže odoslať na server iba požiadavku ako identifikátor URI prostriedku. Ale potom, pred odoslaním požiadavky na server, existuje REST API, ktoré nám poskytuje architektúru vrstveného systému. To znamená, že môžeme mať API nasadené na jednom serveri, dáta sú nasadené na inom serveri a autentifikácia na inom serveri.
• Kód na požiadanie (voliteľný): Niekedy môže klient potrebovať viac ako len odpoveď. REST API nám umožňuje poslať spustiteľný kód ako odpoveď (týmto spustiteľným kódom môže byť widget alebo akýkoľvek ovládací prvok). Je však úplne voliteľné, či sme túto funkciu povolili / implementovali.

Niekoľko ďalších terminológií týkajúcich sa rozhrania Rest API:

Koncový bod : Je to odkaz na adresu URL, ktorá prijíma webové požiadavky. Webová služba je adresovateľná pomocou odkazu na koncový bod.
Napríklad, Http: // {Domain_URL} //librarygr/libraries.xml

Zdroje : Je to podmnožina koncového bodu. Koncové body zvyčajne vystavujú niektoré objekty, ktoré je možné spotrebovať prostredníctvom webových služieb. Zdroje sú konkrétne tá časť objektu cez URI koncového bodu.
Napríklad, Http: // {Domain_URL} // api / pg_library / ornithology / swan

Užitočné zaťaženie : Užitočné zaťaženie je informácia, ktorá sa odošle počas vykonávania operácie POST alebo PUT. Toto sú informácie uvedené v tele požiadavky HTTP.

to help desk rozhovor otázky a odpovede pdf

Užitočné zaťaženie sa odosiela vo formáte JSON, Napríklad,

Parametre :

Parametre môžeme odovzdať dvoma spôsobmi.

Parametre dopytu : Užitočné na prístup k dvojiciam kľúč / hodnota v reťazci dopytu adresy URL (časť za?)

Najlepší príklad

http://jsonplaceholder.typicode.com/posts/?id=3

Parametre cesty: Je užitočné priradiť časť adresy URL ako parameter. Informácie ako parameter cesty môžeme poslať nasledujúcim spôsobom: Form-data, x-www-form-urlencoded, raw, binary.

Najlepší príklad:

https://api.github.com/gists/49b05378bb8920d5b4ec54efc27103e2/comments

Čo je POSTMAN?

POSTMAN je klient REST, jednoducho aplikácia dodávaná s prehliadačom Chrome. Vyvíja sa, pričom treba mať na pamäti vývojárov, aby sme uľahčili testovanie hovorov API. Má svoje vlastné GUI na odosielanie požiadaviek API a čítanie odpovedí API.

Testovanie rozhrania REST API môžeme vykonať manuálne aj automatizovane.

V nasledujúcej časti sa dozvieme, ako manuálne otestovať webové API pomocou klienta POSTMAN.

Ako otestovať API s poštárom?

Inštalácia

Musíme mať prístup k Internetový obchod Chrome . V prehliadači Chrome vyhľadajte Postman. Kliknite tu pridať do tlačidla Chrome.

Po úspešnej inštalácii nájdeme aplikáciu POSTMAN v aplikácii Chrome. Stačí kliknúť na ikonu Poštár a otvorí sa POSTMAN. Prvé spustenie bude chvíľu trvať.

Informácie o tom, ako používať, nájdete na nasledujúcej adrese URL POŠTOVNÍK ako nástroj.

Predpoklady: Na prístup k službám nasadeným na webe je potrebné pripojenie na internet. V prípade prístupu k lokálne nasadeným službám sa uistite, že sú dostatočné práva a oprávnenia sú dané užívateľovi, ktorý vykonáva test cez POSTMAN.

Fiktívny identifikátor zdroja: V tomto výučbe budeme namiesto skutočného URI používať atrapu URI. Dá nám požadované odpovede, ale na serveri nie je možné vykonať zmeny.

http://jsonplaceholder.typicode.com

Navigačné kroky :

# 1) Po spustení aplikácie POSTMAN sa nám predvolene zobrazí stránka Žiadosť.

#dva) Zoznam volaní API zobrazíme kliknutím na rozbaľovaciu ponuku. Výberom ktorejkoľvek z možností z rozbaľovacej ponuky môžeme požiadať o volanie API na server.

# 3) Kliknite na tlačidlo Premenná prostredia v pravom hornom rohu POŠTOVNÍKA. Nastavte konkrétne prostredie, kde sa chystáme testovať. Môžeme si to odložiť na budúce vykonanie.

# 4) Uložené prostredie je prístupné z rozbaľovacej ponuky Prostredie.

# 5) Ďalej musíme v danom poli nastaviť URI zdroja.

# 6) Kliknutím na tlačidlo Params vedľa poľa URI zdroja zadajte parametre dotazu

rozdiel v c a c ++

# 7) Kliknite na kartu Autorizácia, z rozbaľovacej ponuky vyberte typ autorizácie a nastavte požadovanú autorizáciu, alebo ju môžete jednoducho ponechať ako Žiadna autorizácia.

# 8) Kliknite na kartu Hlavičky a nastavte požadované hlavičky, napríklad typ obsahu

# 9) Kliknite na kartu Text a vyberte prepínač formulárové údaje. Zadajte požadované parametre tela, ktoré je potrebné odoslať spolu s adresou URL žiadosti

# 10) Kliknite na kartu Text a vyberte prepínač x-www-form-urlencoded. Zadajte požadované parametre tela, ktoré je potrebné odoslať ako kódované, spolu s adresou URL žiadosti

#eleven) Kliknite na kartu Text a vyberte prepínač „nespracovaný“. Zadajte požadované parametre tela, ktoré je potrebné odoslať spolu s adresou URL žiadosti. Toto je v skutočnom formáte JSON

# 12) Kliknite na kartu Text a vyberte prepínač „binárny“. Zadajte požadované parametre tela (zvyčajne ako súbor), ktoré je potrebné odoslať spolu s adresou URL žiadosti.

# 13) Po nakonfigurovaní všetkých podrobností, ako je uvedené vyššie, môžeme teraz žiadosť odoslať. Môžeme tiež uložiť požiadavku na odoslanie ako request.json (môžeme zmeniť názov žiadosti).

# 14) Zoznam vykonaných žiadostí vidíme na ľavom bočnom paneli na karte História.

# pätnásť) Môžeme tiež uložiť všetky podrobnosti súvisiace s požiadavkou (URI, autorizácia, parametre, telo atď.) Pod existujúcou zbierkou alebo novou zbierkou. Po pridaní požiadavky do zbierky ju môžeme exportovať (zdieľať) a dokonca môžeme importovať ľubovoľnú existujúcu zbierku.

Zbierku môžeme zdieľať ako odkaz alebo ako tímovú knižnicu jednoduchým generovaným kódom. Vždy môžeme spustiť celú kolekciu Suite.

Dokonca môžeme zverejniť adresu URL zbierky na webe, aby ktokoľvek, kto má prístup k zverejnenej adrese URL, mal prístup do zbierky a využívať služby poskytované webovým rozhraním API.

Existuje funkcia na prihlásenie do aplikácie POSTMAN, ktorá nám umožňuje ukladať históriu, zbierky, údaje o životnom prostredí, lokálne úložisko, aby sme ich mohli ukladať a mať k nim prístup kdekoľvek a kedykoľvek po prihlásení do aplikácie POSTMAN.

Bežec

Používa sa na spustenie prostriedkov nachádzajúcich sa v priečinku Collections.

Záver

Väčšina spoločností prijíma architektonický štýl REST pre vývoj / implementáciu webových služieb, pretože ide o jednoduché a užívateľsky prívetivé rozhranie, ktoré si vyžaduje menej školení pre existujúcich / nových členov projektu. Organizácie zvažujú REST spolu so svojimi existujúcimi webovými službami.

Prečítajte si tiež = >> Výukový program pre Flask API

V nasledujúcom tutoriáli tejto série REST API si rozoberieme rôzne typy kódov odpovedí, typy požiadaviek REST atď.

Odporúčané čítanie

• Kódy odozvy Rest API a typy požiadaviek na odpočinok
• Výukový program POSTMAN: Testovanie API pomocou programu POSTMAN
• Testovanie REST API s uhorkou pomocou prístupu BDD
• 10 najlepších nástrojov na testovanie API v roku 2021 (nástroje na testovanie SOAP a REST API)
• Testovanie REST API s pružinou RestTemplate a TestNG
• Ako automatizovať požiadavky API pomocou nástroja Assurance Rest a Jenkins
• Ako vytvoriť projekt REST v aplikácii SoapUI Pro: Výukový program č. 13
• Výukový program Parasoft SOAtest: Bezskriptový testovací nástroj API