Try it out

Voer een echte request uit vanuit de browser, rechtstreeks vanaf de pagina van een endpoint, met auth-ondersteuning en een same-origin proxy om CORS te vermijden.

Gebruik

Elk request-paneel van een endpoint heeft een Code / Try it out-modusschakelaar naast de taaltabbladen. Try it out is een bewerkbaar formulier (base URL, path-/query-/headerparameters, request body) dat een echte request uitvoert via executeRequest() en het resultaat toont in een Live-tabblad naast de gedeclareerde voorbeeldresponses (netjes geformatteerd wanneer de body JSON is, met een vriendelijke melding in plaats van een ruwe fout bij een netwerk-/CORS-probleem). De base URL staat standaard op de eerste entry in de servers[]-array van het OpenAPI-document, indien aanwezig, en is altijd vrij te bewerken.

Authenticatie

Endpoints met een security-vereiste krijgen een inline auth-formulier, één invoerveld per gedeclareerd schema:

  • apiKey: gaat naar een header of query-param, afhankelijk van de gedeclareerde locatie.
  • http bearer / OAuth2 / OpenID Connect: accepteert allemaal een token dat je rechtstreeks plakt; er wordt geen OAuth-flow uitgevoerd.
  • http basic: verwacht user:pass.

Credentials zijn globaal (gedeeld over elk endpoint dat dat schema gebruikt, zoals een echt dev-token dat zou zijn) en blijven bewaard in localStorage, zodat ze een reload overleven.

Bevat een geslaagde Live-response een veld dat op een token lijkt (bijv. de access_token van een login-endpoint, ook genest onder een envelope zoals data.access_token), dan laat een knop "Gebruik als … token" je die hergebruiken als credential voor de rest van de sessie, zonder handmatig kopiëren/plakken.

Same-origin proxy

Standaard is Try it out een directe fetch() vanuit de browser naar de doel-API, onderworpen aan het eigen CORS-beleid van die API. Is nestjs-docfy's DocfyUiModule.setup() (zie de API-referentie) geconfigureerd met een OpenAPI-document, dan detecteert docfy-ui de geïnjecteerde globale window.__DOCFY_PROXY_PATH__ en routeert het verzoek in plaats daarvan via een same-origin server-side proxy, zodat CORS nooit een rol speelt.

De allowlist van de proxy wordt alleen opgebouwd uit absolute URL's in de servers[]-array van het document. Er is geen impliciete "zelfde origin als deze request"-fallback, omdat die zou afhangen van door de client bepaalde headers. Een verzoek voor een niet-toegestane origin, of elke andere fout bij de proxy zelf, komt terug met een X-Docfy-Proxy-Error-responseheader, zodat docfy-ui een fout op proxy-niveau kan onderscheiden van een echte response van je eigen API.