Obe API plochy — Enterprise API aj SAPI-SK — sú popísané jednou OpenAPI špecifikáciou. Nie je to ručne písaný dokument: vzniká z definícií samotných rout a rozchod medzi ňou a kódom zachytí test už na strane API. Čo si z nej stiahnete, teda zodpovedá tomu, čo server naozaj robí.
Kde ju stiahnuť
| Adresa | Obsah |
|---|---|
/openapi.json | Celá špecifikácia, obe API naraz. |
/openapi/enterprise.json | Len Enterprise API — cesty pod /api/v1, /api/auth, /health a /metrics. |
/openapi/sapi.json | Len SAPI-SK — cesty pod /sapi. |
Interaktívne vyskúšanie
Kompletnú referenciu so schémami, príkladmi požiadaviek aj odpovedí a tlačidlom Try it
nájdete na /docs. Enterprise API je predvolené, SAPI-SK je pod záložkou
/docs#sapi.
Generovanie klienta
Špecifikáciu prijme ktorýkoľvek bežný generátor (openapi-generator, orval, NSwag,
Kiota). Väčšina operácií má vyplnené operationId a práve z neho generátory odvodzujú
názvy funkcií — createApiKey, listApiKeys, getBalance. Rovnaký postup používame aj
my sami: klient, ktorým portál volá vlastné API, je generovaný z tohto súboru.