<RequestExample>
y <ResponseExample>
muestran bloques de código en la barra lateral derecha para crear un diseño de dos columnas que mantiene los ejemplos visibles mientras los usuarios se desplazan por tu contenido. Estos componentes están pensados para documentación de API, pero funcionan en todas las páginas.
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
<RequestExample>
y <ResponseExample>
se muestran como bloques de código normales y se pueden omitir al desplazarse.
RequestExample
<RequestExample>
para anclar ejemplos de código en la barra lateral derecha. Este componente funciona de manera 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
ResponseExample
<ResponseExample>
fija ejemplos de código en la barra lateral derecha, debajo de cualquier contenido de <RequestExample>
en la misma página.
ResponseExample