x-codeSamples, ou récupérez-les depuis Speakeasy.
Définissez api.examples.languages dans votre docs.json pour choisir les langages qui apparaissent dans les exemples générés. Les langages s’affichent dans l’ordre où vous les listez.
docs.json
defaults sur required pour exclure les paramètres facultatifs des exemples générés. La valeur par défaut, all, les inclut.
Tous les langages pris en charge
Tous les langages pris en charge
api.examples.autogenerate sur false. Les pages d’endpoint affichent alors uniquement les x-codeSamples de votre spécification, ou les composants <RequestExample> sur les pages MDX.
Ajoutez la propriété x-codeSamples à n’importe quelle opération. Elle suit le schéma suivant.
Le libellé de l’exemple. Utile lorsque vous fournissez plusieurs exemples pour un même endpoint.
1
Récupérez l'URL de la spécification combinée depuis le registre
Accédez à votre tableau de bord Speakeasy et ouvrez l’onglet API Registry. Ouvrez l’entrée 
Depuis la page de l’entrée du registre, copiez l’URL publique fournie.
*-with-code-samples de votre API.
Si l’entrée n’est pas étiquetée Combined Spec, vérifiez que votre API dispose d’une URL d’exemples de code automatiques configurée.
2
Ajoutez l'URL de la spécification combinée à votre fichier docs.json
Ajoutez l’URL de la spécification combinée à une ancre ou à un onglet dans l’objet
navigation de votre fichier docs.json.3
Vérifiez l'intégration
Après avoir redéployé votre documentation, ouvrez n’importe quel endpoint dans votre référence d’API et confirmez que les extraits par langage apparaissent dans le playground. L’ensemble des langages disponibles correspond aux cibles de SDK configurées dans votre projet Speakeasy.Si les extraits n’apparaissent pas, vérifiez que :
- L’URL
openapidansdocs.jsonpointe vers l’entrée de spécification combinée*-with-code-samples, et non vers le fichier OpenAPI source. - L’URL de la spécification combinée est accessible publiquement depuis le navigateur.
- Votre projet Speakeasy dispose d’une URL d’exemples de code automatisés configurée et d’au moins une cible de SDK activée.