mirror of
https://github.com/mintlify/docs.git
synced 2026-09-14 13:35:46 +08:00
bbb1a08ed3
Co-authored-by: locadex-agent[bot] <217277504+locadex-agent[bot]@users.noreply.github.com>
86 lines
3.6 KiB
Plaintext
86 lines
3.6 KiB
Plaintext
---
|
||
title: "Speakeasy"
|
||
description: "Automatisez les extraits de code des SDK dans votre bac à sable d’API."
|
||
keywords: ["Speakeasy SDK", "SDK générés automatiquement", "exemples de code de SDK", "intégration au bac à sable d’API"]
|
||
---
|
||
|
||
Les extraits de code générés automatiquement à partir des SDK Speakeasy peuvent être intégrés directement dans la documentation de référence d’API de Mintlify. Des exemples d’utilisation des SDK s’affichent dans le [bac à sable interactif](/fr/api-playground/overview) des sites de documentation propulsés par Mintlify.
|
||
|
||
<Frame>
|
||

|
||
</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#creating-the-repository).
|
||
* 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>
|
||

|
||
</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>
|
||

|
||
</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"
|
||
}
|
||
]
|
||
}
|
||
```
|
||
|
||
Les extraits de code générés par Speakeasy peuvent désormais être affichés dans votre documentation d’API et utilisés dans l’aire de jeu.
|