APIpliekštis – tai specializuotas programos sąsajos (API) dokumentas, kuris aiškiai apibrėžia, kokius duomenis API gauna ir grąžina, taip pat galimus klaidos atsakymus. Jis naudojamas automatizuotam API testavimui ir validacijai.
Pavyzdžiai:
- Įvestis: `GET /api/vartotojai/{id}`
- Išvestis: `200 OK` su JSON objekto (pvz., vartotojo duomenys) schemos aprašu.
- Klaidos atsakymas: `404 Not Found` su klaidos pranešimu.
Trumpai: APIpliekštis yra API „sutartis“, nurodanti, kaip sistema turi reaguoti į užklausas, padedanti užtikrinti, kad API veiktų tikėtinai.
Jūsų pataisymai bus išsiųsti moderatorių peržiūrai, jei informacija tikslesnė/taisyklingesnė
ji bus patalpinta vietoj esamos.