API Probeer Dit!
Die PROBEER DIT!-funksie laat u toe om u API direk in u blaaier te toets. Dit werk beide op 'n gepubliseerde dokumentasieportaal of direk binne die redigeerder.
Hoe om te konfigureer
Die Probeer dit!-funksie gebruik die fetch API, dus om dit te laat werk, moet u API-imports die volgende hê:
- 'n absolute pad-URL na u API (nie net 'n pad nie)
- voeg 'n URL soos volg in u .yml-lêer by
- servers:
- URL-voorbeeld: https://petstore3.swagger.io/api/v3 (u werklike URL)
- magtigingsmetodes sal vanaf u api-lêer gelees en op elke API-bladsy ingesluit word
- CORS gedeaktiveer of geaktiveer vir die dokumentasiedomein, sodat gebruikers werklik u API kan toets
Hoe dit werk
Importeer u API-lêers (direkte import of github-sinkronisering)
[Opsioneel] Definieer "verstek"-waardes in u OpenAPI-lêer. Op hierdie manier, wanneer u u API invoer, sal alle "default"-waardes by die kodevoorbeeld gevoeg word, en u kan u API onmiddellik toets sonder die behoefte om handmatig waardes by params te voeg.
Konfigureer die API-metode met die toetsparams
Nadat u die parameters opgedateer het, sal die kodevoorbeeld aan die regterkant (of onder, afhangende van hoe u u aansig stel) ook opgedateer word met die toetsparams wat u bygevoeg het, en die kodebrokkie van die versoek in verskeie tale aan u verskaf
Klik die Probeer dit!-knoppie en kyk na die responsarea onder die voorbeeldkode
