Väittämät
API-tarkistuksen väittämät
Mitä ovat väittämät?
Väittämät ovat ehtoja, jotka asetat API-pyyntösi tilakoodin ja vasteajan validoimiseksi. Ne auttavat varmistamaan, että API-rajapintasi käyttäytyy odotetulla tavalla eri olosuhteissa. Kun yksi tai useampi väittämä epäonnistuu, hälytys laukaistaan, mikä mahdollistaa välittömän toiminnan.
Väittämien tyypit
Voit asettaa seuraavan tyyppiset väittämät API-tarkistuksillesi:
- Vasteaika: Aseta arvo ja tarkista sitä vasten. Jos vasteaika ylittää määritetyn arvon, väittämä epäonnistuu ja testi epäonnistuu.
- Tilakoodi: Määritä API-vastauksen odotettu tilakoodi. Jos vastauskoodi eroaa odotetusta arvosta, väittämä epäonnistuu ja API-tarkistus epäonnistuu.
Epäonnistuneet väittämät ja tarkistustiedot
Kun väittämä epäonnistuu, epäonnistumisen yksityiskohdat näkyvät tarkistuksen tietosivulla. Tämä sisältää tiedon siitä, mikä väittämä epäonnistui ja miksi, mikä auttaa tunnistamaan ja ratkaisemaan ongelmat nopeasti.
Vuorovaikutus vasteaikarajojen kanssa
Jos tarkistuksella on vasteaikaraja ja se on merkitty heikentyneeksi, mutta sillä on myös epäonnistunut väittämä, tarkistus merkitään epäonnistuneeksi. Tämä varmistaa, että kaikki kriittiset ongelmat havaitaan ja käsitellään viipymättä.
Väittämien asettaminen
- Siirry väittämäasetuksiin: Navigoi API-tarkistuksesi väittämäasetuksiin.
- Lisää väittämiä: Määritä lisättävän väittämän tyyppi (vasteaika, tilakoodi).
- Aseta kriteerit: Määritä väittämän kriteerit (esim. odotettu tilakoodi, enimmäisvasteaika).
- Tallenna asetukset: Muista tallentaa asetuksesi väittämien soveltamiseksi.
Käytännön käyttötapaukset
- Suorituskyvyn seuranta: Käytä vasteaikaväittämiä varmistaaksesi, että API-rajapintasi täyttää suorituskykyvaatimukset.
- Virheiden havaitseminen: Käytä tilakoodiväittämiä odottamattomien virheiden tai epäonnistumisten havaitsemiseksi API-rajapinnassasi.
Käyttämällä väittämiä voit varmistaa, että API-rajapintasi suoriutuvat odotetulla tavalla ja toimittavat oikeaa dataa, mikä auttaa ylläpitämään palveluidesi luotettavuutta ja suorituskykyä.