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: "Ajouter des exemples de SDK"
|
||
description: "Afficher des extraits de code de SDK dans votre documentation d’API."
|
||
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.
|
||
|
||
Cette propriété peut être ajoutée à n’importe quelle méthode de requête et 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 });
|
||
```
|