Mostrar variaciones de respuesta para el mismo endpoint
Si tu API devuelve diferentes respuestas según los parámetros de entrada, el contexto del usuario u otras condiciones de la solicitud, puedes documentar múltiples ejemplos de respuesta con la propiedad examples.Esta propiedad se puede añadir a cualquier respuesta y tiene el siguiente esquema.
Copy
Ask AI
responses: "200": description: Respuesta correcta 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