Passer au contenu principal
  curl --request POST \
    --url https://dog-api.kinduff.com/api/facts

{ "status": "success" }
Les composants <RequestExample> et <ResponseExample> affichent des code blocks dans la barre latérale droite pour créer une mise en page en deux colonnes, afin de garder les exemples visibles pendant que les utilisateurs font défiler votre contenu. Ces composants sont conçus pour la documentation d’API, mais ils fonctionnent sur toutes les pages. Cas d’usage courants :
  • Documentation d’API endpoint avec des exemples de requête et de réponse
  • Exemples de configuration accompagnés de texte explicatif
  • Extraits de code auxquels les utilisateurs se réfèrent en suivant des instructions
  • Exemples avant/après dans des tutoriels
Sur mobile, les composants <RequestExample> et <ResponseExample> s’affichent comme des code blocks et peuvent être dépassés au défilement. 
  curl --request POST \
    --url https://dog-api.kinduff.com/api/facts

{ "status": "success" }

​
RequestExample

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

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

</RequestExample>

​
ResponseExample

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

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

</ResponseExample>
⌘I