Ejemplos
Muestra ejemplos de código en el panel derecho de la barra lateral en escritorio para mostrar muestras de solicitud y respuesta junto a la API.
Los componentes <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. Usa estos componentes para la 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
En dispositivos móviles, los componentes <RequestExample> y <ResponseExample> se muestran como bloques de código en estilo regular que los usuarios pueden omitir al desplazarse.
curl --request POST \
--url https://dog-api.kinduff.com/api/facts{ "status": "success" }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>
```bash Solicitud
curl --request POST \
--url https://dog-api.kinduff.com/api/facts
```
</RequestExample>El componente <ResponseExample> ancla ejemplos de código en la barra lateral derecha, debajo de cualquier contenido <RequestExample> en la misma página.
<ResponseExample>
```json Respuesta
{ "status": "success" }
```
</ResponseExample>Tanto <RequestExample> como <ResponseExample> aceptan las siguientes propiedades:
dropdownbooleanMostrar un menú desplegable de idiomas para alternar entre bloques de código, en lugar del diseño de pestañas predeterminado.