Try it out

Ejecuta una request real desde el navegador, directamente desde la página de un endpoint, con soporte de auth y un proxy same-origin para evitar CORS.

Uso

El panel de request de cada endpoint tiene un selector de modo Code / Try it out junto a las tabs de lenguaje. Try it out es un formulario editable (base URL, parámetros de path/query/header, request body) que ejecuta una request real vía executeRequest() y muestra el resultado en una tab Live junto a las respuestas de ejemplo declaradas (con pretty-print cuando el body es JSON, con un mensaje amigable en vez de un error crudo en un fallo de red/CORS). La base URL usa por defecto la primera entrada del array servers[] del documento OpenAPI cuando existe, y siempre es libremente editable.

Autenticación

Los endpoints con un requisito de security obtienen un formulario de auth inline, un input por scheme declarado:

  • apiKey: va a un header o query param, según su ubicación declarada.
  • http bearer / OAuth2 / OpenID Connect: todos aceptan un token que pegas directamente; no se ejecuta ningún flujo OAuth.
  • http basic: espera user:pass.

Las credenciales son globales (compartidas entre todos los endpoints que usan ese scheme, como sería un token de desarrollo real) y persisten en localStorage para sobrevivir a un reload.

Cuando una respuesta Live exitosa contiene un campo con forma de token (ej. el access_token de un endpoint de login, incluso anidado bajo un envelope como data.access_token), un botón "Use as … token" te deja reutilizarlo como credencial durante el resto de la sesión, sin copiar/pegar manual.

Proxy same-origin

Por defecto, Try it out hace un fetch() directo del navegador a la API de destino, sujeto a la política CORS de esa API. Cuando DocfyUiModule.setup() de nestjs-docfy (consulta la referencia de la API) se configura con un documento OpenAPI, docfy-ui detecta el global inyectado window.__DOCFY_PROXY_PATH__ y en su lugar enruta la request por un proxy same-origin en el servidor, así que CORS nunca entra en juego.

La allowlist del proxy se construye solo a partir de URLs absolutas en el array servers[] del documento. No hay fallback implícito de "mismo origen que esta request", ya que eso dependería de headers controlados por el cliente. Una request a un origen no permitido, o cualquier otro fallo en el propio proxy, vuelve con un header de respuesta X-Docfy-Proxy-Error, para que docfy-ui pueda distinguir un fallo a nivel de proxy de una respuesta real de tu API.