Hé! API (aktív gyógyszerészeti összetevők) beszállítójaként gyakran megkérdezik, hogy mi az API séma. Tehát azt gondoltam, hogy időbe telik egy kis idő, hogy lebontjam neked oly módon, hogy könnyen érthető.
Kezdjük az alapokkal. Az API séma olyan, mint egy API tervrajza. Ez egy részletes leírás arról, hogy az API hogyan működik, milyen adatokra számít, és milyen adatokkal fog visszatérni. Gondolj rá olyan szabályok és iránymutatások, amelyeket mind az API -szolgáltatónak (az én vagyok!), Mind az API -fogyasztónak (azaz te vagy a csapatod) követnie kell a zökkenőmentes és hatékony kommunikáció biztosítása érdekében.
Miért fontos az API séma?
Nos, képzelje el, hogy házat épít. Nem csak elkezdené a tégla dobását terv nélkül, igaz? Ugyanez vonatkozik az API -kra. Az API séma egyértelmű és következetes módot kínál a fejlesztők számára az API megértésére és használatára. Segít elkerülni a félreértéseket, csökkenti a hibák esélyét, és megkönnyíti az API integrálását a különböző alkalmazásokba.
Tegyük fel például, hogy fejlesztő vagy, aki az API -t használja, hogy hozzáférjen az információkhozNano-karbonizált niobium, mikron niobium karbid, ultra-finom niobium karbid, HFC- Az API séma pontosan megmondja, hogy milyen végpontok állnak rendelkezésre, milyen paramétereket kell átadnia, és milyen formátumban fog szerepet játszani. Ez sokkal könnyebbé teszi a kód írását az API -val való kölcsönhatáshoz és a szükséges adatok megszerzéséhez.
Mi van egy API sémában?
Az API séma általában a következő összetevőket tartalmazza:
1. Végpontok
Ezek azok az URL -ek, amelyeket felhívhat az API funkcionalitásához. Mindegyik végpont egy konkrét műveletet képvisel, például a termékek listájának megszerzését, az új megrendelés létrehozását vagy a felhasználói információk frissítését.
2. Kérési és válaszformátumok
A séma meghatározza az adatok (pl. JSON, XML) elküldéséhez szükséges adatok formátumát, valamint az API által a válaszaiban visszatérő adatok formátumát. Ez biztosítja, hogy mind az API -szolgáltató, mind a fogyasztó ugyanazon az oldalon legyen az adatkezelés során.
3. Paraméterek
Ezek az értékek, amelyeket átadhat egy végponthoz a művelet testreszabásához. Például átadhat egy termékazonosítványt, hogy információt szerezzen egy adott termékről, vagy egy dátumtartományt a megrendelések listájának kiszűrésére.
4. Hibakezelés
A séma azt is leírja, hogy az API hogyan fogja kezelni a hibákat. Meghatározza azokat a hibakódokat, amelyeket az API visszaadhat, és mit jelent az egyes kódok. Ez segít a fejlesztőknek megérteni, mi történt rosszul, ha hiba következik be, és hogyan javíthatjuk.
Az API sémák típusai
Számos típusú API -séma létezik, mindegyiknek megvan a saját előnye és felhasználási esetei. A leggyakoribbak a következők:
OpenAPI specifikáció (OAS)
Ez az egyik legnépszerűbb szabvány a RESTful API -k dokumentálására. YAML vagy JSON fájlt használ az API végpontjainak, kérési és válaszformátumainak, paramétereinek és még sok másnak a leírására. Az OAS -t széles körben támogatják az eszközök és a keretek, amelyek megkönnyítik a dokumentáció, az SDK és a teszt esetek előállítását.
GraphQL séma
A GraphQL egy API -k lekérdezési nyelve, amely lehetővé teszi az ügyfelek számára, hogy pontosan kérjék a szükséges adatokat. A GraphQL séma meghatározza az API visszaadható adat típusait és az ilyen típusokon végrehajtható műveleteket. Rugalmasabb és hatékonyabb módszert kínál az adatok hozzáférésére a hagyományos RESTful API -khoz képest.
Protokollpufferek
A protokoll pufferek (ProtoBUF) egy nyelv-agnosztikus bináris sorosítási formátum, amelyet a Google fejlesztett ki. Schema fájlt használ az adatok felépítésének meghatározására, amelyet soroznak és draszterálnak. A ProtoBuf nagy teljesítményéről és kis üzenetméretéről ismert, így népszerű választás az API -k számára, amelyeknek nagy mennyiségű adat kezelésére van szükségük.
Hogyan használjuk az API sémákat API -beszállítóként
API -beszállítóként az API sémákra támaszkodunk annak biztosítása érdekében, hogy API -k könnyen használhatók és integrálódjanak. Az OpenAPI specifikációt használjuk az API -k dokumentálására, amely lehetővé teszi számunkra, hogy világos és részletes dokumentációt nyújtsunk ügyfeleink számára. Ez a dokumentáció információkat tartalmaz a végpontokról, a kérés és a válasz formátumokról, a paraméterekről és a hibakezelésről.
Az API sémákat is használjuk az ügyfelek által kapott kérések validálására. A bejövő kérelmek ellenőrzésével a sémával szemben biztosíthatjuk, hogy az adatok a megfelelő formátumban vannak, és hogy az összes szükséges paraméter jelen van. Ez elősegíti a hibák megelőzését, és biztosítja, hogy API -k megbízhatóak és biztonságosak legyenek.
Ezenkívül API sémákat használunk az SDK -k és a teszt esetek előállításához. Az OpenAPI specifikációját támogató eszközök használatával automatikusan generálhatunk kódot különböző programozási nyelveken, ami megkönnyíti ügyfeleink számára az API -k integrálását az alkalmazásukba. A sémát is használjuk teszt esetek előállításához, amely segít abban, hogy az API -k helyesen működjenek, és hogy megfeleljenek ügyfeleink követelményeinek.
Valós példák
Vessen egy pillantást néhány valós példára az API sémák használatának módjára.
1. példa: Az API segítségével információt szerezhetünkKiváló minőségű tioxanthen-9-one CAS: 492-22-8
Tegyük fel, hogy kutató vagy, aki információt szeretne szerezni egy adott kémiai vegyületről. Az API segítségével hozzáférhet olyan adatokhoz, mint a vegyület tulajdonságai, szintézis módszerei és biztonsági információk. Az API séma pontosan megmondja, hogy milyen végpontot kell hívnia, milyen paramétereket kell átadni (pl. A CAS szám), és milyen formátumban fog bekövetkezni.
Íme egy példa az API -hoz nyújtott kérésre a CURL segítségével:
curl -x get "https://api.oursite.com/compounds/492-22-8" -h "elfogadás: alkalmazás/json"A válasz valami hasonlónak tűnhet:
{"név": "thioxanthen-9-a-on", "Cas_number": "492-22-8", "molecular_weight": 212.26, "tulajdonságok": {"olving_point": "85-87 ° C", "Boiling_point": "365,7 ° C 760 mmhg"}, "Synthes_meths": "365,7 ° c X Y -vel z ... "," 2. módszer: Használja a következő reakciófeltételeket ... "]}2. példa: Új megrendelés létrehozásaCAS No.4555943-61-0 nagy ellátás
Ha Ön egy gyógyszergyártó társaság, amely egy adott API nagy szállítására törekszik, akkor az API -t új megrendelés létrehozására használhatja. Az API séma meghatározza a megrendelés, a kérési formátum (pl. A megrendelés részletei, a mennyiségi és a kézbesítési cím) létrehozásának végpontját, valamint a válaszformátumot (pl. A megrendelés azonosítója és a megerősítő üzenet).
Íme egy példa az API -ba a Python segítségével:
Import kérések url = "https://api.oursite.com/orders" data = {"product_id": "455943-61-0", "mennyiség": 1000, "delivision_address": "123 main st, naftown, amerikai"} fejlécek = {"tartalom-típusú": "alkalmazás/json"} reage = kérés (urak "} fejlécek = {" tartalom-típusú ":" alkalmazás/json "} response = kérés. fejlécek = fejlécek) Nyomtatás (Response.json ())A válasz valami hasonlónak tűnhet:
{"rend_id": "123456", "Üzenet": "A rendelés sikeresen létrehozta. A megrendelését 24 órán belül feldolgozzák." }Következtetés
Összegezve: az API séma minden API kritikus része. Világos és következetes módot kínál a fejlesztők számára az API megértésére és használatára, csökkenti a hibák esélyét, és megkönnyíti az API integrálását a különböző alkalmazásokba. API -beszállítóként az API -sémákra támaszkodunk annak biztosítása érdekében, hogy API -k könnyen használhatók, megbízhatóak és biztonságosak legyenek.
Ha érdekli az API -k felhasználása a termékeinkkel kapcsolatos információkhoz való hozzáféréshez vagy a megrendelések elhelyezéséhez, szeretnénk hallani rólad. Függetlenül attól, hogy kutató, gyógyszeripari vállalat vagy fejlesztő vagy, API -k biztosíthatják a szükséges adatokat és funkcionalitást. Tehát ne habozzon kapcsolatba lépni velünk, hogy megvitassuk az Ön igényeit és megkezdje a beszerzési folyamatot. Azért vagyunk itt, hogy segítsünk abban, hogy a lehető legtöbbet hozza ki az API -kból, és biztosítsuk, hogy a velünk való tapasztalata pozitív legyen.
Referenciák
- Fielding, RT (2000). Építészeti stílusok és a hálózati alapú szoftver-architektúrák tervezése. Kaliforniai Egyetem, Irvine.
- Khare, R. és Frystyk, H. (1997). Hypertext transzfer protokoll - HTTP/1.1. RFC 2068.
- Lindley, S., és Miller, B. (2015). GraphQL: Adat lekérdezési nyelv. Facebook.
- Varda, A. (2008). Protokoll pufferek: A Google adatcseréje formátuma. Google nyílt forráskódú blog.
