Files
mintlify__docs/fr/integrations/sdks/speakeasy.mdx
locadex-agent[bot] 9d82233e1c docs(locadex): add translations (#4029)
Co-authored-by: locadex-agent[bot] <217277504+locadex-agent[bot]@users.noreply.github.com>
2026-03-04 16:49:02 -08:00

86 lines
3.6 KiB
Plaintext
Raw Permalink Blame History

This file contains invisible Unicode characters
This file contains invisible Unicode characters that are indistinguishable to humans but may be processed differently by a computer. If you think that this is intentional, you can safely ignore this warning. Use the Escape button to reveal them.
This file contains Unicode characters that might be confused with other characters. If you think that this is intentional, you can safely ignore this warning. Use the Escape button to reveal them.
---
title: "Speakeasy"
description: "Affichez des exemples de code de SDK générés automatiquement par Speakeasy dans votre bac à sable d’API, dans différentes langues."
keywords: ["Speakeasy SDK", "SDK générés automatiquement", "exemples de code de SDK", "intégration au bac à sable d’API"]
---
Vous pouvez intégrer les extraits de code générés automatiquement à partir des SDK Speakeasy directement dans la documentation de référence d’API de Mintlify. Les exemples d’utilisation des SDK apparaissent dans le [bac à sable interactif](/fr/api-playground/overview) des sites de documentation propulsés par Mintlify.
<Frame>
![Un bac à sable d’API Mintlify avec des extraits de code Speakeasy.](/images/speakeasy/mintlify-with-speakeasy-openapi.png)
</Frame>
<div id="prerequisites">
## Prérequis
</div>
Pour intégrer Mintlify à Speakeasy, vous aurez besoin des éléments suivants :
- Un [référentiel de documentation Mintlify](/fr/quickstart).
- Un SDK généré par Speakeasy avec une [URL d’exemples de code automatisés](https://www.speakeasy.com/docs/code-samples/automated-code-sample-urls) configurée.
<div id="setting-up-the-integration">
## Configuration de l’intégration
</div>
Pour intégrer Speakeasy à Mintlify, vous devez récupérer l’URL publique de la spécification combinée de l’API depuis le registre, puis mettre à jour votre fichier de configuration `docs.json`.
<div id="get-the-apis-combined-spec-public-url-from-the-registry">
### Récupérer l’URL publique de la spécification combinée de l’API depuis le registre
</div>
Accédez à votre [Dashboard Speakeasy](https://app.speakeasy.com) et ouvrez l’onglet **API Registry**. Ouvrez l’entrée `*-with-code-samples` de l’API.
<Frame>
![Capture d’écran de la page Speakeasy API Registry. L’onglet API Registry est mis en évidence par un carré rouge avec le numéro 1 et l’entrée de l’API est mise en évidence par un carré rouge avec le numéro 2.](/images/speakeasy/openapi-registry-and-combined-spec.png)
</Frame>
<Note>
Si l’entrée n’est pas étiquetée **Combined Spec**, vérifiez que l’API a une [URL d’exemples de code automatisée](https://www.speakeasy.com/docs/code-samples/automated-code-sample-urls) configurée.
</Note>
Depuis la page de l’entrée du registre, copiez l’URL publique fournie.
<Frame>
![Capture d’écran montrant l’entrée du registre de la spécification combinée avec la fonction de copie d’URL mise en évidence par un carré rouge.](/images/speakeasy/copy-combined-spec-url.png)
</Frame>
<div id="update-your-docsjson-configuration-file">
### Mettez à jour votre fichier de configuration `docs.json`
</div>
Ajoutez l’URL de la spécification combinée dans une section **Anchors** ou **Tabs** de votre fichier `docs.json`.
Ajoutez l’URL de la spécification combinée à une ancre en mettant à jour le champ `anchor` dans votre fichier `docs.json` comme suit :
```json docs.json
{
"anchors": [
{
"name": "Référence de l'API",
// !mark
"openapi": "SPEAKEASY_COMBINED_SPEC_URL",
"url": "api-reference",
"icon": "square-terminal"
}
]
}
```
Ajoutez l’URL de la spécification combinée à un onglet en mettant à jour le champ `tab` dans le fichier `docs.json` comme suit :
```json docs.json
{
"tabs": [
{
"name": "Référence de l'API",
"url": "api-reference",
// !mark
"openapi": "SPEAKEASY_COMBINED_SPEC_URL"
}
]
}
```
Vous pouvez désormais afficher les extraits de code générés par Speakeasy dans votre documentation d’API et interagir avec eux dans le playground.