mirror of
https://github.com/mintlify/docs.git
synced 2026-09-14 13:35:46 +08:00
mintlify[bot]
fbdd913d8e
* Add translation tracker for stale translations audit Generated-By: mintlify-agent * translations: add missing pages and update content for es, fr, zh Phase 1: Add translations for 4 new API analytics pages (feedback-by-page, searches, views, visitors) in es, fr, and zh. Phase 2: Update 3 pages with content changes: - agent/workflows: add "Disable a workflow" subsection - ai/skillmd: add 24-hour generation note - editor/publish: add AI PR title tip, reformat publishing workflows, promote "Publish your changes" heading from h3 to h2 Co-Authored-By: Claude Sonnet 4.6 <noreply@anthropic.com> * update descriptions * translations * translations * translations * Delete TRANSLATION_TRACKER.md * translations * a * a * translations * translations * translations * translations * translations * translations * translations * translations * Update use-cases.mdx * translations * translations * Update ai-native.mdx * Update accordions.mdx * Update accordions.mdx * Update accordions.mdx * translations * translations * Update fonts.mdx * translations * translations: update SEO descriptions for es, fr, zh (150 pages) Update the description: frontmatter field across 150 pages × 3 languages to match the current English descriptions updated on 2026-03-31. Co-Authored-By: Claude Sonnet 4.6 <noreply@anthropic.com> --------- Co-authored-by: mintlify[bot] <109931778+mintlify[bot]@users.noreply.github.com> Co-authored-by: Ethan Palm <56270045+ethanpalm@users.noreply.github.com> Co-authored-by: Claude Sonnet 4.6 <noreply@anthropic.com>
75 lines
2.5 KiB
Plaintext
75 lines
2.5 KiB
Plaintext
---
|
|
title: "Ejemplos"
|
|
description: "Muestra ejemplos de código en el panel derecho de la barra lateral en dispositivos de escritorio junto a la documentación de API."
|
|
keywords: ["RequestExample", "ResponseExample", "code examples", "request-response"]
|
|
---
|
|
|
|
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.
|
|
|
|
<RequestExample>
|
|
```bash Request
|
|
curl --request POST \
|
|
--url https://dog-api.kinduff.com/api/facts
|
|
```
|
|
</RequestExample>
|
|
|
|
<ResponseExample>
|
|
```json Response
|
|
{ "status": "success" }
|
|
```
|
|
</ResponseExample>
|
|
|
|
<div id="requestexample">
|
|
## RequestExample
|
|
</div>
|
|
|
|
Usa `<RequestExample>` para fijar ejemplos de código en la barra lateral derecha. Este componente funciona de forma similar al componente [CodeGroup](/es/components/code-groups), 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.
|
|
|
|
````mdx RequestExample
|
|
<RequestExample>
|
|
|
|
```bash Solicitud
|
|
curl --request POST \
|
|
--url https://dog-api.kinduff.com/api/facts
|
|
```
|
|
|
|
</RequestExample>
|
|
````
|
|
|
|
<div id="responseexample">
|
|
## ResponseExample
|
|
</div>
|
|
|
|
El componente `<ResponseExample>` ancla ejemplos de código en la barra lateral derecha, debajo de cualquier contenido `<RequestExample>` en la misma página.
|
|
|
|
````mdx ResponseExample
|
|
<ResponseExample>
|
|
|
|
```json Respuesta
|
|
{ "status": "success" }
|
|
```
|
|
|
|
</ResponseExample>
|
|
````
|
|
|
|
<div id="properties">
|
|
## Propiedades
|
|
</div>
|
|
|
|
Tanto `<RequestExample>` como `<ResponseExample>` aceptan las siguientes propiedades:
|
|
|
|
<ResponseField name="dropdown" type="boolean">
|
|
Mostrar un menú desplegable de idiomas para alternar entre bloques de código, en lugar del diseño de pestañas predeterminado.
|
|
</ResponseField>
|