API Kokeile!
KOKEILE!-ominaisuuden avulla voit testata APIasi suoraan selaimessasi. Se toimii sekä julkaistussa dokumentaatioportaalissa että suoraan editorin sisällä.
Määritysten tekeminen
Kokeile!-ominaisuus käyttää fetch APIa, joten jotta se toimisi, API-tuonneissasi täytyy olla seuraavat asetukset:
- absoluuttinen polun URL APIllesi (ei pelkkä polku)
- lisää .yml-tiedostoosi URL seuraavasti
- servers:
- URL-esimerkki: https://petstore3.swagger.io/api/v3 (todellinen URL-osoitteesi)
- valtuutusmenetelmät luetaan api-tiedostostasi ja sisällytetään jokaiselle API-sivulle
- CORS poistettuna käytöstä tai käytössä dokumentaatiodomainille, jotta käyttäjät voivat todella testata APIasi
Kuinka se toimii
Tuo API-tiedostosi (suora tuonti tai github-synkronointi)
[Valinnainen] Määritä "oletus"-arvot OpenAPI-tiedostossasi. Tällä tavalla, kun tuot APIsi, kaikki "default"-arvot lisätään koodiesimerkkiin, ja voit testata APIasi välittömästi ilman, että sinun tarvitsee lisätä arvoja parametreihin manuaalisesti.
Määritä API-metodi testiparametreilla

Kun päivität parametrit, oikealla oleva (tai alapuolella oleva sen mukaan, miten olet määrittänyt näkymäsi) koodiesimerkki päivittyy myös lisäämilläsi testiparametreilla ja tarjoaa pyynnön koodikatkelman useilla kielillä

Paina Kokeile!-painiketta ja tarkista vastausalue mallikoodin alapuolella
