Vo svete moderného vývoja softvéru sa Restful API objavili ako základný kameň na budovanie škálovateľných, efektívnych a interoperabilných aplikácií. Ako dodávateľ API som bol svedkom z prvej ruky na transformačnú silu API REST API REST, ktorý umožnil bezproblémovú komunikáciu medzi rôznymi softvérovými systémami. V tomto blogu sa podelím o svoje poznatky o tom, ako vytvoriť API REST, od základných konceptov po praktické kroky implementácie.
Pochopenie pokojovej architektúry
Predtým, ako sa ponoríte do procesu vytvárania, je nevyhnutné pochopiť, čo je odpočinok (reprezentatívny prenos štátu). REST je architektonický štýl, ktorý definuje súbor obmedzení, ktoré sa majú použiť na vytváranie webových služieb. Restful API dodržiava tieto obmedzenia, ktoré zahŕňajú bez štátnej príslušnosti, celoštátnosť, jednotné rozhranie, vrstvený systém a kód - dopyt (voliteľné).
Obzvlášť dôležité je jednotné obmedzenie rozhrania. To znamená, že API by malo mať konzistentný spôsob interakcie so zdrojmi. Zdroje sú kľúčové abstrakcie v pokoji a môžu byť čokoľvek od užívateľského profilu po katalóg produktov. Každý zdroj je identifikovaný jedinečným URI (jednotný identifikátor zdrojov) a klienti interagujú s týmito zdrojmi pomocou štandardných metód HTTP, ako sú Get, Post, Put, Delete.
Plánovanie vášho REST API
Prvým krokom pri vytváraní rozhrania REST API je plánovanie. Zahŕňa to definovanie zdrojov, ktoré vaše API vystaví, operácie, ktoré sa dajú vykonať na týchto zdrojoch, a formáty údajov, ktoré sa použijú na žiadosti a odpovede.
Definovanie zdrojov
Začnite identifikáciou hlavných entít vo vašom systéme, ktoré chcete vystaviť prostredníctvom rozhrania API. Napríklad, ak budujete API E - Commerce API, vaše zdroje môžu obsahovať produkty, zákazníkov a objednávky. Každý zdroj by mal mať jasné a zmysluplné meno a jeho URI by mala odrážať jeho hierarchický vzťah s inými zdrojmi. Napríklad URI pre konkrétny produkt môže byť/produkty/{produkt_id}, kde{produkt_id}je jedinečný identifikátor produktu.
Určovanie operácií
Po definovaní svojich zdrojov sa musíte rozhodnúť, aké operácie môžu byť vykonané. Tu je bežné mapovanie metód HTTP na prevádzku:
- Dostať: Načítať zdroj alebo zbierku zdrojov. Napríklad
Get /Productsby mohol vrátiť zoznam všetkých výrobkov, zatiaľGet /produkty /{produkt_id}vrátilo by podrobnosti o konkrétnom produkte. - Post: Vytvorte nový zdroj. Napríklad
Príspevok /výrobkyVďaka užitočnému zaťaženiu JSON by v systéme vytvorilo nový produkt produkt. - Uviesť: Aktualizujte existujúci zdroj.
Put /produkty /{produkt_id}S aktualizovanými podrobnosťami o produkte v užitočnom zaťažení by prepísali existujúce informácie o produkte. - Vymazať: Odstráňte zdroj.
Delete /Products /{produkt_id}Odstraňoval by určený produkt zo systému.
Výber dátových formátov
JSON (notácia objektu JavaScript) je najbežnejšie používaný formát údajov pre REST API kvôli jeho jednoduchosti a širokej podpore v rôznych programovacích jazykoch. XML je ďalšou možnosťou, ale je to podrobnejšie. Pri navrhovaní svojho rozhrania API sa rozhodnite o formáte údajov, ktoré použijete na požiadavky a odpovede, a jasne ho dokumentujte.
Navrhovanie koncových bodov API
Po plánovaní je čas navrhnúť koncové body API. Koncový bod je špecifická URI, ktorú klienti majú prístup k vykonaniu operácie na zdroji.
Pomenovanie konvencií
Používajte množné podstatné mená pre názvy zdrojov vo vašom URI. Napríklad/výrobkynamiesto tohoprodukt. Preto je jasné, že koncový bod predstavuje zbierku zdrojov. Použite tiež spojovníky na oddelenie slov v URI pre lepšiu čitateľnosť, a nie podčiarknuté alebo Camelcase.
Parametre dotazov
Na filtrovanie, triedenie a pagináciu použite parametre dotazu. Napríklad, aby ste získali zoznam produktov zoradených podľa ceny vo vzostupnom poradí, môžete použiť URI/produkty? Sort = Cena a objednávka = ASC. Na implementáciu stránky môžete použiť parametre akoobmedzenieakompenzáciaako napríklad/produkty? Limit = 10 & offset = 20Ak chcete získať tretiu stranu po 10 produktoch.


Implementácia API REST
Existuje veľa programovacích jazykov a rámcov, ktoré sú k dispozícii na implementáciu rozhraní REST API. Tu použijem Python a Flask Framework.
Z banky Import Bank, jsonify, request app = banka (__ name__) # Mock Data for Products Products = [{"id": 1, "name": "Product 1", "Cena": 10.99}, {"id": 2, "name": "Product 2"): 19.99}] # Získajte všetky produkty @App.Route ('/produkty', ['Get'). get_products (): return jsonify (produkty) # Získajte jeden produkt @app.Route ('/produkty/produkty/int: produkt_id>', metódy = [get ']) def get_product (produkt_id): produkt = next ((p pre p pre P v produkte P ["id"] == Product_id), ak Product: návrat jsonify (produkt) vráti jsonify (" 404 # Vytvorenie nového produktu @app.Route ('/produkty', metódy = ['post']) def create_product (): new_product = request.get_json () new_product ["id"] = Len (produkty) + 1 produkt (produkt/produkt/produkt/product: int: '' metódy = ['put']) def update_product (produkt_id): produkt = next (((p pre p v produktoch, ak p ["id"] == produkt_id), none) Ak je produkt: Aktualizovaný_data = request.get_json () produkt.update (aktualizácia_data) return jsonify (produkt) návrat jSonify ({"Message": "Product"}) @app.Route ('/produkty/<int: produkt_id>', metódy = ['delete']) def delete_product (produkt_id): globálne produkty = [p pre P v produktoch, ak p ["id"]! = produkt_id] return jSonify ({"správa": "Product deletedne"}) Ak __Name__
V tomto príklade sme vytvorili jednoduché rozhranie REST API pre správu produktov. API má koncové body na získanie všetkých produktov, získanie jedného produktu, vytvorenie nového produktu, aktualizáciu existujúceho produktu a odstránenie produktu.
Manipulácia s chybami a validácia
Robustné rozhranie REST API by malo vyriešiť chyby elegantne a poskytovať klientom zmysluplné chybové správy. Ak dôjde k chybe, vráťte príslušný stavový kód HTTP spolu s objektom JSON obsahujúcim chybové hlásenie. Napríklad, ak sa klient pokúsi získať prístup k neexistujúcemu prostriedku, vráťte stavový kód 404 so správou ako „Zdroj sa nenašiel“.
Validácia je tiež rozhodujúca. Pred vykonaním akýchkoľvek operácií na údaje získané od klientov ich overte, aby sa zabezpečilo, že spĺňa požiadavky. Napríklad, ak sa očakáva, že cena produktu bude kladným číslom, skontrolujte, či hodnota prijatá v žiadosti je skutočne kladné číslo.
Bezpečnostné úvahy
Zabezpečenie je najvyššou prioritou pri vytváraní rozhrania REST API. Tu je niekoľko bezpečnostných opatrení, ktoré by ste mali zvážiť:
Autentifikácia
Používajte mechanizmy autentifikácie, ako sú Keys API, OAuth alebo JWT (webové tokeny JSON), aby ste zaistili, že k vášmu rozhrania API majú prístup iba autorizovaní klienti. Kľúče API sa dajú jednoduché implementovať, ale nemusia byť také bezpečné ako OAuth alebo JWT. OAUTH je široko používaný protokol na delegovaný prístup, zatiaľ čo JWT je token obsahovaný samostatne, ktorý sa dá použiť na autentifikáciu a autorizáciu žiadostí.
Oprávnenie
Akonáhle je klient autentifikovaný, musíte zistiť, aké akcie majú povolené vykonávať. To je miesto, kde prichádza autorizácia. Napríklad pravidelný používateľ by mohol byť schopný zobraziť svoj vlastný profil, zatiaľ čo správca môže prezerať a upravovať všetky profily používateľov.
Zadanie dezininácie
Aby sa zabránilo útokom, ako je injekcia SQL alebo skriptovanie na mieste (XSS), dezinfikujte všetky vstupy od klientov. To znamená odstránenie alebo kódovanie akýchkoľvek potenciálne škodlivých znakov.
Dokumentácia
Dobrá dokumentácia je nevyhnutná pre úspech vášho rozhrania REST API. Pomáha klientom pochopiť, ako používať vaše API a čo od neho očakávať. Na generovanie interaktívnej dokumentácie pre vaše API môžete použiť nástroje ako Swagger alebo OpenAPI. Dokumentácia by mala obsahovať podrobnosti o koncových bodoch, podporovaných metódach HTTP, formátoch údajov o požiadavkách a odozve a akýchkoľvek parametrov dopytu alebo hlavičkách, ktoré je potrebné použiť.
Záver
Vytvorenie rozhrania REST API si vyžaduje starostlivé plánovanie, návrh, implementáciu a testovanie. Dodržiavaním princípov pokojnej architektúry, definovaním jasných zdrojov a operácií a zvážením bezpečnosti a dokumentácie môžete vybudovať vysoko kvalitné API, ktoré vyhovuje potrebám vašich klientov.
Ako dodávateľ APIS ponúkame širokú škálu rozhraní API vrátaneKvalitný hydrobromid lappaconitínu, C32H45BRN2O8, CAS: 97792 - 45 - 5,Dobrá kvalita Albendazol, CAS: 54965 - 21 - 8, C12H15N3O2SaNajvyšší stupň Rifampicin, 13292 - 46 - 1 GMP Standard, C43H58N4O12. Ak vás zaujíma naše rozhrania API alebo máte nejaké otázky týkajúce sa vytvorenia vlastného rozhrania REST API, neváhajte nás kontaktovať kvôli obstarávaniu a ďalším diskusiám.
Odkazy
- Richardson, Leonard a Sam Ruby. RESTUL Web Services. O'Reilly Media, 2007.
- Fielding, Roy Thomas. Architektonické štýly a návrh softvérových architektúr založených na sieti. Dizertačná práca, Kalifornská univerzita, Irvine, 2000.
