Exemples

Afficher des blocs de code dans la barre latérale droite sur ordinateur

Les composants <RequestExample> et <ResponseExample> affichent des blocs de code dans la barre latérale droite pour créer une mise en page en deux colonnes qui maintient 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’un endpoint d’API avec des exemples de requête et de réponse
• Exemples de configuration accompagnés d’un 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 blocs de code classiques et peuvent être dépassés au défilement.

Request

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

Response

{ "status": "success" }

​

RequestExample

Utilisez <RequestExample> pour épingler des exemples de code dans la barre latérale droite. Ce composant fonctionne de manière similaire au composant CodeGroup, mais affiche le code dans la barre latérale plutôt qu’en ligne.

Vous pouvez inclure plusieurs blocs de code dans un seul <RequestExample>. Chaque bloc de code doit avoir un attribut title.

ExempleDeRequête

<RequestExample>

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

</RequestExample>

​

ResponseExample

Le composant <ResponseExample> fixe des exemples de code dans la barre latérale droite, sous tout contenu <RequestExample> présent sur la même page.

ExempleDeRéponse

<ResponseExample>

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

</ResponseExample>