mirror of
https://github.com/mintlify/docs.git
synced 2026-09-14 13:35:46 +08:00
mintlify[bot]
2ccd573b95
Co-authored-by: mintlify[bot] <109931778+mintlify[bot]@users.noreply.github.com>
76 lines
2.6 KiB
Plaintext
76 lines
2.6 KiB
Plaintext
---
|
||
title: "Exemples"
|
||
description: "Affichez des exemples de code dans le panneau latéral droit sur ordinateur pour montrer les requêtes et réponses à côté de la documentation d'API."
|
||
keywords: ["RequestExample", "ResponseExample", "code examples", "request-response"]
|
||
boost: 3
|
||
---
|
||
|
||
Les composants `<RequestExample>` et `<ResponseExample>` affichent des code blocks dans la barre latérale droite afin de créer une mise en page à deux colonnes qui maintient les exemples visibles pendant que les utilisateurs font défiler votre contenu. Utilisez ces composants pour la documentation d’API, mais ils fonctionnent sur toutes les pages.
|
||
|
||
Cas d’utilisation courants :
|
||
|
||
* Documentation d’API endpoint avec des exemples de requête et de réponse
|
||
* Exemples de configuration accompagnés d’un texte explicatif
|
||
* Exemples de code auxquels les utilisateurs se réfèrent en suivant des instructions
|
||
* Exemples « avant/après » dans des tutoriels
|
||
|
||
Sur les appareils mobiles, les composants `<RequestExample>` et `<ResponseExample>` s’affichent comme des code blocks que les utilisateurs peuvent dépasser en faisant défiler.
|
||
|
||
<RequestExample>
|
||
```bash Request
|
||
curl --request POST \
|
||
--url https://dog-api.kinduff.com/api/facts
|
||
```
|
||
</RequestExample>
|
||
|
||
<ResponseExample>
|
||
```json Response
|
||
{ "status": "success" }
|
||
```
|
||
</ResponseExample>
|
||
|
||
<div id="requestexample">
|
||
## RequestExample
|
||
</div>
|
||
|
||
Utilisez `<RequestExample>` pour épingler des exemples de code dans la barre latérale droite. Ce composant fonctionne de façon similaire au composant [CodeGroup](/fr/components/code-groups), mais affiche le code dans la barre latérale plutôt qu’en ligne.
|
||
|
||
Vous pouvez inclure plusieurs code blocks dans un seul `<RequestExample>`. Chaque code block doit avoir un attribut title.
|
||
|
||
````mdx RequestExample
|
||
<RequestExample>
|
||
|
||
```bash Requête
|
||
curl --request POST \
|
||
--url https://dog-api.kinduff.com/api/facts
|
||
```
|
||
|
||
</RequestExample>
|
||
````
|
||
|
||
<div id="responseexample">
|
||
## ResponseExample
|
||
</div>
|
||
|
||
Le composant `<ResponseExample>` épingle les exemples de code dans la barre latérale droite, sous tout contenu `<RequestExample>` présent sur la même page.
|
||
|
||
````mdx ResponseExample
|
||
<ResponseExample>
|
||
|
||
```json Réponse
|
||
{ "status": "success" }
|
||
```
|
||
|
||
</ResponseExample>
|
||
````
|
||
|
||
<div id="properties">
|
||
## Propriétés
|
||
</div>
|
||
|
||
`<RequestExample>` et `<ResponseExample>` acceptent les propriétés suivantes :
|
||
|
||
<ResponseField name="dropdown" type="boolean">
|
||
Afficher un menu déroulant de langues pour basculer entre les blocs de code, au lieu de la disposition par onglets par défaut.
|
||
</ResponseField>
|