Būsenos puslapis API tiekėjams

Jūsų klientai yra kūrėjai: jiems reikia ne tik būsenos, bet ir srauto, kurį galima skaityti programiškai.

Kuo API klientas skiriasi

Kai jūsų produktas yra API, būsenos puslapį skaito ne tik žmogus:

Kūrėjas nori RSS ar JSON srauto, ne naujienlaiškio
Kliento sistema nori žinoti, ar gedimas jūsų pusėje, prieš pradedant kartoti užklausas
Integracijų komanda nori matyti istoriją prieš pasirašydama SLA

Gražu, bet neautomatizuojama. Kūrėjas nori adreso, kurį gali skaityti jo kodas.

Per incidentą vėluoja būtent tada, kai svarbiausia, o po jo lieka spragos istorijoje.

„API veikia“ nieko nesako, kai neveikia tik mokėjimų galinis taškas.

Kiekvienas puslapis turi mašinai skaitomą srautą, tad kliento sistema gali sekti jūsų būseną be žmogaus.

Prie adreso pridėjus .md arba nusiuntus Accept: text/markdown, puslapis grįžta tekstu — patogu ir agentams, ir dokumentacijai.

Atskiri komponentai autentifikacijai, mokėjimams, webhook'ams. Matyti tiksliai, kas paveikta.

SVG ženkliukas su dabartine būsena ir veikimo rodikliu, kurį galima įdėti į dokumentaciją ar GitHub puslapį.

1Sukuriate stebėjimus pagrindiniams galiniams taškams su tikrinimo sąlygomis
2Suskirstote komponentus pagal tai, ką klientas iškviečia
3Įjungiate RSS, JSON ir ženkliuką dokumentacijoje
4Nurodote puslapį savo API dokumentacijoje ir klaidų atsakymuose
5Per incidentą skelbiate atnaujinimus — srautas pasiekia klientų sistemas iškart

Stebėjimus galima laikyti kode: YAML failas ir viena CLI komanda.

Ar yra mašinai skaitomas srautas?

Taip: RSS, Atom ir JSON, o visą puslapį galima gauti Markdown formatu.

Ar galiu tikrinti ne tik HTTP?

Taip: HTTP, TCP, DNS, ICMP, gRPC ir UDP, su sąlygomis statusui, antraštėms, turiniui ir trukmei.

Ar galiu įdėti ženkliuką į README?

Taip, SVG ženkliukas rodo dabartinę būseną arba veikimo rodiklį.