mirror of
https://github.com/mintlify/docs.git
synced 2026-09-14 13:35:46 +08:00
locadex-agent[bot]
97dd998f47
Co-authored-by: locadex-agent[bot] <217277504+locadex-agent[bot]@users.noreply.github.com>
57 lines
1.8 KiB
Plaintext
57 lines
1.8 KiB
Plaintext
---
|
|
title: "Respuestas múltiples"
|
|
description: "Documenta múltiples variaciones de respuestas para endpoints de la API."
|
|
keywords: ["response examples", "conditional responses", "response variations", "examples property"]
|
|
---
|
|
|
|
Si tu API devuelve respuestas diferentes según los parámetros de entrada, el contexto del usuario u otras condiciones de la solicitud, puedes documentar múltiples ejemplos de respuestas con la propiedad `examples`.
|
|
|
|
Agrega esta propiedad a cualquier respuesta. Tiene el siguiente esquema.
|
|
|
|
```yaml
|
|
responses:
|
|
"200":
|
|
description: Respuesta exitosa
|
|
content:
|
|
application/json:
|
|
schema:
|
|
$ref: "#/components/schemas/YourResponseSchema"
|
|
examples:
|
|
us:
|
|
summary: Respuesta para Estados Unidos
|
|
value:
|
|
countryCode: "US"
|
|
currencyCode: "USD"
|
|
taxRate: 0.0825
|
|
gb:
|
|
summary: Respuesta para Reino Unido
|
|
value:
|
|
countryCode: "GB"
|
|
currencyCode: "GBP"
|
|
taxRate: 0.20
|
|
```
|
|
|
|
El playground también maneja de forma diferente los tipos de respuesta que no son JSON según su tipo de contenido.
|
|
|
|
|
|
<div id="audio-response-examples">
|
|
## Ejemplos de respuestas de audio
|
|
</div>
|
|
|
|
Para los endpoints que devuelven archivos de audio, establece el tipo de contenido de la respuesta en `audio/*` y proporciona la URL de un archivo de audio como valor de ejemplo. El playground muestra un reproductor de audio interactivo en lugar de un fragmento de código.
|
|
|
|
```yaml
|
|
responses:
|
|
"200":
|
|
description: Audio file generated successfully
|
|
content:
|
|
audio/mpeg:
|
|
schema:
|
|
type: string
|
|
format: binary
|
|
examples:
|
|
sample:
|
|
summary: Sample audio output
|
|
value: "https://example.com/sample-audio.mp3"
|
|
```
|