mirror of
https://github.com/mintlify/docs.git
synced 2026-09-14 13:35:46 +08:00
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: "Ajouter des exemples de SDK"
|
||
description: "Ajoutez des exemples de code SDK à votre documentation d’API avec des exemples générés automatiquement par Speakeasy et Stainless en plusieurs langages."
|
||
keywords: ["x-codeSamples", "Exemples de SDK"]
|
||
---
|
||
|
||
Si vos utilisateurs interagissent avec votre API à l’aide d’un SDK plutôt que directement via une requête réseau, vous pouvez utiliser l’extension `x-codeSamples` pour ajouter des extraits de code à votre document OpenAPI et les afficher dans vos pages OpenAPI.
|
||
|
||
Ajoutez cette propriété à n’importe quelle méthode de requête. Elle a le schéma suivant.
|
||
|
||
<ParamField body="lang" type="string" required>
|
||
La langue de l’extrait de code.
|
||
</ParamField>
|
||
|
||
<ParamField body="label" type="string">
|
||
Le libellé de l’exemple. Utile lorsque vous fournissez plusieurs exemples pour un même endpoint.
|
||
</ParamField>
|
||
|
||
<ParamField body="source" type="string" required>
|
||
Le code source de l’exemple.
|
||
</ParamField>
|
||
|
||
Voici un exemple d’extraits de code pour une application de suivi de plantes, qui propose à la fois un outil CLI Bash et un SDK JavaScript.
|
||
|
||
```yaml
|
||
paths:
|
||
/plants:
|
||
get:
|
||
# ...
|
||
x-codeSamples:
|
||
- lang: bash
|
||
label: Lister toutes les plantes non arrosées
|
||
source: |
|
||
planter list -u
|
||
- lang: javascript
|
||
label: Lister toutes les plantes non arrosées
|
||
source: |
|
||
const planter = require('planter');
|
||
planter.list({ unwatered: true });
|
||
- lang: bash
|
||
label: Lister toutes les plantes en pot
|
||
source: |
|
||
planter list -p
|
||
- lang: javascript
|
||
label: Lister toutes les plantes en pot
|
||
source: |
|
||
const planter = require('planter');
|
||
planter.list({ potted: true });
|
||
```
|