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>
50 lines
1.8 KiB
Plaintext
50 lines
1.8 KiB
Plaintext
---
|
|
title: "Agregar ejemplos de SDK"
|
|
description: "Añade ejemplos de código de SDK a tu documentación de API con ejemplos autogenerados de Speakeasy y Stainless en múltiples lenguajes."
|
|
keywords: ["x-codeSamples", "ejemplos de SDK"]
|
|
---
|
|
|
|
Si tus usuarios interactúan con tu API mediante un SDK en lugar de hacerlo directamente mediante una solicitud de red, puedes usar la extensión `x-codeSamples` para agregar ejemplos de código a tu documento de OpenAPI y mostrarlos en tus páginas de OpenAPI.
|
|
|
|
Agrega esta propiedad a cualquier método de solicitud. Tiene el siguiente esquema.
|
|
|
|
<ParamField body="lang" type="string" required>
|
|
El idioma del ejemplo de código.
|
|
</ParamField>
|
|
|
|
<ParamField body="label" type="string">
|
|
La etiqueta del ejemplo. Es útil cuando se proporcionan varios ejemplos para un mismo endpoint.
|
|
</ParamField>
|
|
|
|
<ParamField body="source" type="string" required>
|
|
El código fuente del ejemplo.
|
|
</ParamField>
|
|
|
|
A continuación se muestra un ejemplo de muestras de código para una aplicación de seguimiento de plantas, que cuenta tanto con una herramienta CLI de Bash como con un SDK de JavaScript.
|
|
|
|
```yaml
|
|
paths:
|
|
/plants:
|
|
get:
|
|
# ...
|
|
x-codeSamples:
|
|
- lang: bash
|
|
label: Listar todas las plantas sin regar
|
|
source: |
|
|
planter list -u
|
|
- lang: javascript
|
|
label: Listar todas las plantas sin regar
|
|
source: |
|
|
const planter = require('planter');
|
|
planter.list({ unwatered: true });
|
|
- lang: bash
|
|
label: Listar todas las plantas en maceta
|
|
source: |
|
|
planter list -p
|
|
- lang: javascript
|
|
label: Listar todas las plantas en maceta
|
|
source: |
|
|
const planter = require('planter');
|
|
planter.list({ potted: true });
|
|
```
|