mirror of
https://github.com/mintlify/docs.git
synced 2026-09-14 13:35:46 +08:00
locadex-agent[bot]
e42653a294
Co-authored-by: locadex-agent[bot] <217277504+locadex-agent[bot]@users.noreply.github.com>
50 lines
1.7 KiB
Plaintext
50 lines
1.7 KiB
Plaintext
---
|
|
title: "Agregar ejemplos de SDK"
|
|
description: "Muestra ejemplos de código de SDK en tu documentación de API."
|
|
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.
|
|
|
|
Esta propiedad se puede agregar a cualquier método de solicitud y 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 });
|
|
```
|