Vo svete moderného vývoja softvéru sa rozhrania programovania aplikácií (API) stali chrbtom bezproblémovej výmeny údajov medzi rôznymi softvérovými systémami. Ako dodávateľ API chápem kritickú úlohu, ktorú http stavu kódov zohrávajú v reakciách API. Tieto stavebné kódy sú ako ukazovatele na digitálnej diaľnici, vedú vývojárov a používateľov prostredníctvom zložitej krajiny žiadostí a odpovedí údajov. V tomto blogovom príspevku sa ponorím do významu stavových kódov HTTP v reakciách API, skúmam ich význam a spôsob, akým ovplyvňujú celkové skúsenosti s API.
Pochopenie stavových kódov HTTP
Stavové kódy HTTP sú tri - číslicové čísla vrátené serverom v reakcii na požiadavku HTTP klienta. Poskytujú štandardizovaný spôsob, ako oznámiť výsledok žiadosti, či bol úspešný, narazil na chybu alebo vyžaduje ďalšie kroky. Prvá číslica stavového kódu označuje všeobecnú kategóriu odpovede, zatiaľ čo zostávajúce dve číslice poskytujú konkrétnejšie informácie.
1xx: Informačný
Stavové kódy 1XX sa používajú primárne na informačné účely. Naznačujú, že server žiadosť prijal a pokračuje v jej spracovaní. Tieto kódy sa zriedka vyskytujú v každodenných interakciách API, pretože sa používajú hlavne na medziprodukty počas rokovacej fázy žiadosti. Napríklad a100 pokračujteStavový kód hovorí klientovi, že môže pokračovať v odosielaní zvyšku žiadosti.
2xx: úspech
Stavové kódy 2xx znamenajú, že žiadosť bola úspešne prijatá, pochopená a spracovaná serverom. Toto je najžiadanejší výsledok pre akúkoľvek žiadosť o API. Niektoré z bežne používaných stavových kódov 2xx v odpovediach API zahŕňajú:
- 200 ok: Toto je najzákladnejší kód úspechu. Znamená to, že žiadosť bola úspešná a server vrátil požadované údaje. Napríklad, keď klient požiada o zoznam produktov z API E - Commerce API, a
200 okStavový kód s údajmi o produkte v tele odpovedí znamená, že žiadosť bola úspešne splnená. - Vytvorené 201: Tento kód sa používa, keď bol na serveri úspešne vytvorený nový zdroj. Napríklad, ak klient odošle požiadavku na príspevok na vytvorenie nového používateľského účtu v Autentifikation API, a
Vytvorené 201Stavový kód spolu s podrobnosťami novovytvoreného používateľa naznačuje, že účet bol úspešne vytvorený. - 204 Žiadny obsah: Tento stavový kód sa vráti, keď bola žiadosť úspešná, ale neexistuje žiadny obsah na návrat. Napríklad, keď klient odošle požiadavku na odstránenie odstránenia prostriedku zo servera, a
204 Žiadny obsahStavový kód naznačuje, že prostriedok bol úspešne odstránený.
3xx: presmerovanie
Stavové kódy 3xx sa používajú na označenie, že klient musí podniknúť ďalšie kroky na dokončenie žiadosti. Zvyčajne to zahŕňa presmerovanie klienta na inú adresu URL. Niektoré bežné štatútové kódy 3xx zahŕňajú:
- 301 sa pohybovalo natrvalo: Tento kód naznačuje, že požadovaný zdroj bol trvalo presunutý do novej adresy URL. Klient by mal aktualizovať svoje záznamy a použiť novú adresu URL pre budúce požiadavky.
- 302 nájdených: Podobné ako
301, ale presmerovanie je dočasné. Klient by mal naďalej používať pôvodnú adresu URL pre budúce požiadavky.
4xx: Chyba klienta
Stav 4XX Stav kódy signalizuje, že klient v žiadosti urobil chybu. Dôvodom môže byť neplatný vstup, neoprávnený prístup alebo iné klientske vedľajšie problémy. Niektoré dobre - známe 4XX Stavové kódy sú:
- 400 Zlá žiadosť: Tento kód naznačuje, že server nerozumel žiadosti z dôvodu neplatnej syntaxe. Napríklad, ak klient odošle chybné užitočné zaťaženie JSON v žiadosti o príspevok do API, server môže vrátiť a
400 Zlá žiadosťstavový kód. - 401 neoprávnené: To znamená, že klient musí overiť prístup k požadovanému prostriedku. Napríklad, ak sa klient pokúsi získať prístup k chránenému koncovému bodu API bez poskytnutia platných overovacích poverení, server bude reagovať
401 neoprávnenéstavový kód. - 403 zakázané: Tento stavový kód naznačuje, že klient je autentifikovaný, ale nemá povolenie na prístup k požadovanému prostriedku. Napríklad pravidelný používateľ, ktorý sa snaží získať prístup k správcovi - iba koncový bod API dostane a
403 zakázanéodpoveď. - 404 nenájdené: Toto je jeden z najznámejších kódov stavu. To znamená, že požadovaný zdroj sa nedal nájsť na serveri. Napríklad, ak klient požiada o koncový bod neexistujúceho API, server vráti a
404 nenájdenéstavový kód.
5XX: Chyba servera
Stavové kódy 5xx naznačujú, že na strane servera je chyba. Dôvodom môže byť nesprávna konfigurácia servera, chyba v kóde servera alebo iné interné problémy. Niektoré bežné stavebné kódy 5xx sú:
- 500 chyba interného servera: Toto je všeobecný chybový kód, ktorý naznačuje, že na serveri sa niečo pokazilo. Mohlo by to byť spôsobené chybou databázy, chybou kódu alebo inými nepredvídanými problémami.
- 503 služba nedostupná: Tento kód naznačuje, že server dočasne nedokáže túto požiadavku zvládnuť. Dôvodom môže byť údržba, preťaženie alebo iné dočasné problémy.
Dôležitosť stavových kódov HTTP v odpovediach API
Ako dodávateľ API je použitie správnych kódov stavu HTTP v odpovediach API rozhodujúce z niekoľkých dôvodov:
Jasná komunikácia
Stavové kódy HTTP poskytujú jasný a štandardizovaný spôsob oznámenia výsledku žiadosti. Vývojári môžu ľahko pochopiť, či bola žiadosť úspešná, narazila na chybu alebo vyžaduje ďalšie kroky na základe statusu kódu. To zjednodušuje proces vývoja a znižuje čas strávený ladením.
Zaobchádzanie
Správne používanie stavových kódov pomáha vývojárom implementovať efektívne chyby - spracovanie mechanizmov v ich aplikáciách. Napríklad, ak klient dostane a400 Zlá žiadosťStavový kód, môže používateľovi vyzvať, aby opravil vstup. Ak a500 chyba interného serveraje prijatý, klient môže používateľovi informovať, že na strane servera je problém a neskôr sa žiadosť znovu pokúsi.
Použiteľnosť API
No - definované statové kódy zlepšujú použiteľnosť API. Keď vývojári vedia, čo môžu očakávať od stavových kódov, môžu vytvárať robustnejšie a spoľahlivejšie aplikácie. To zase zvyšuje prijatie API a zvyšuje celkovú skúsenosť používateľa.
Skutočné - príklady sveta
Zoberme si nejaké skutočné príklady sveta, ako sa v odpovediach API používajú kódy stavu HTTP. Predpokladajme, že máme API pre farmaceutickú spoločnosť, ktorá poskytuje informácie o aktívnych farmaceutických prísadách, ako napríkladAzasetronový hydrochlorid,GuaifenesinaPyrazinamid.
- Úspešná žiadosť: Klient odošle žiadosť GET API na získanie informácií o Guaifenesíne. Ak je žiadosť úspešná, server vráti a
200 okStavový kód spolu s podrobnými informáciami o guaifenesíne v tele odpovedí. - Chyba klienta: Klient odošle žiadosť o príspevok na vytvorenie nového záznamu pre zložku, ale užitočné zaťaženie JSON v žiadosti chýba požadované pole. Server vráti a
400 Zlá žiadosťStavový kód, ktorý naznačuje, že žiadosť je neplatná. - Chyba servera: Z dôvodu výpadku databázy server nedokáže spracovať požiadavku na získanie informácií o pyrazinamide. Server vráti a
500 chyba interného serveraStavový kód, informujúci klienta, že na strane servera je problém.
Vedúci kontakt pre obstarávanie
Ak máte záujem o integráciu našich rozhraní API do vašich aplikácií alebo máte nejaké otázky týkajúce sa údajov, ktoré poskytujeme farmaceutickými prísadami, odporúčame vám, aby ste sa nás obrátili na obstarávanie a ďalšie diskusie. Naše rozhrania API sú navrhnuté tak, aby poskytovali presné a až - do dátumu informácií o rôznych aktívnych farmaceutických ingredienciách, ktoré môžu byť pre vaše obchodné operácie neoceniteľné. Či už ste farmaceutický výrobca, výskumná inštitúcia alebo iná organizácia, ktorá potrebuje spoľahlivé služby API, sme tu, aby sme vám pomohli.
Odkazy
- Fielding, RT, Gettys, J., Mogul, JC, Frystyk, H., Masinter, L., Leach, P., & Berners - Lee, T. (1999). Protokol prenosu Hypertext - HTTP/1.1. RFC 2616.
- Reschke, J. (2014). Protokol Hypertext Transfer Protocol (HTTP/1.1): Sémantika a obsah. RFC 7231.