curl --request POST \
    --url https://dog-api.kinduff.com/api/facts
{ "status": "success" }
I componenti <RequestExample> e <ResponseExample> mostrano blocchi di codice nella barra laterale destra per creare un layout a due colonne che mantiene gli esempi visibili mentre gli utenti scorrono i contenuti. Questi componenti sono pensati per la documentazione delle API, ma funzionano su tutte le pagine. Casi d’uso comuni:
  • Documentazione degli endpoint API con esempi di richiesta e risposta
  • Esempi di configurazione affiancati da testo esplicativo
  • Esempi di codice a cui gli utenti si riferiscono mentre seguono le istruzioni
  • Esempi “prima e dopo” nei tutorial
Su dispositivi mobili, i componenti <RequestExample> e <ResponseExample> vengono visualizzati come normali blocchi di codice e scorrono insieme alla pagina.
  curl --request POST \
    --url https://dog-api.kinduff.com/api/facts
{ "status": "success" }

RequestExample

Usa <RequestExample> per ancorare esempi di codice nella barra laterale destra. Questo componente funziona in modo simile a CodeGroup, ma mostra il codice nella barra laterale invece che in linea. Puoi includere più blocchi di codice all’interno di un singolo <RequestExample>. Ogni blocco di codice deve avere un attributo title.
RequestExample
<RequestExample>

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

</RequestExample>

ResponseExample

Il componente <ResponseExample> blocca gli esempi di codice nella barra laterale destra, al di sotto di qualsiasi contenuto <RequestExample> presente nella stessa pagina.
ResponseExample
<ResponseExample>

```json Response
{ "status": "success" }
```

</ResponseExample>