Exemples

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.

curl --request POST \
  --url https://dog-api.kinduff.com/api/facts

{ "status": "success" }

Utilisez <RequestExample> pour épingler des exemples de code dans la barre latérale droite. Ce composant fonctionne de façon similaire au composant CodeGroup, 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.

<RequestExample>

```bash Requête
curl --request POST \
  --url https://dog-api.kinduff.com/api/facts
```

</RequestExample>

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.

<ResponseExample>

```json Réponse
{ "status": "success" }
```

</ResponseExample>

<RequestExample> et <ResponseExample> acceptent les propriétés suivantes :