Ejemplos - Mintlify

RequestExample

Usa <RequestExample> para fijar ejemplos de código en la barra lateral derecha. Este componente funciona de forma similar al componente CodeGroup, pero muestra el código en la barra lateral en lugar de en línea. Puedes incluir varios bloques de código dentro de un solo <RequestExample>. Cada bloque de código debe tener un atributo title.

RequestExample

<RequestExample>

```bash Solicitud
curl --request POST \
  --url https://dog-api.kinduff.com/api/facts
```

</RequestExample>

ResponseExample

El componente <ResponseExample> ancla ejemplos de código en la barra lateral derecha, debajo de cualquier contenido <RequestExample> en la misma página.

ResponseExample

<ResponseExample>

```json Respuesta
{ "status": "success" }
```

</ResponseExample>

Propiedades

Tanto <RequestExample> como <ResponseExample> aceptan las siguientes propiedades:

• dropdown: boolean — Mostrar un menú desplegable de idiomas para alternar entre bloques de código, en lugar del diseño de pestañas predeterminado.

Casos de uso comunes:

• Documentación de endpoints de API con ejemplos de solicitud y respuesta
• Ejemplos de configuración junto con texto explicativo
• Fragmentos de código que los usuarios consultan mientras siguen instrucciones
• Ejemplos de antes y después en tutoriales