curl --request POST \
    --url https://dog-api.kinduff.com/api/facts
{ "status": "success" }
Os componentes <RequestExample> e <ResponseExample> exibem blocos de código na barra lateral direita para criar um layout de duas colunas que mantém os exemplos visíveis enquanto os usuários percorrem seu conteúdo. Esses componentes foram projetados para documentação de API, mas funcionam em todas as páginas. Casos de uso comuns:
  • Documentação de endpoints de API com exemplos de requisição e resposta
  • Exemplos de configuração acompanhados de texto explicativo
  • Exemplos de código que os usuários consultam enquanto seguem as instruções
  • Exemplos de antes e depois em tutoriais
Em dispositivos móveis, os componentes <RequestExample> e <ResponseExample> são exibidos como blocos de código comuns e podem ser rolados.
  curl --request POST \
    --url https://dog-api.kinduff.com/api/facts
{ "status": "success" }

RequestExample

Use <RequestExample> para fixar exemplos de código na barra lateral direita. Este componente funciona de forma similar ao componente CodeGroup, mas exibe o código na barra lateral em vez de incorporado no texto. Você pode incluir vários blocos de código dentro de um único <RequestExample>. Cada bloco de código deve ter um atributo title.
RequestExample
<RequestExample>

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

</RequestExample>

ResponseExample

O componente <ResponseExample> fixa exemplos de código na barra lateral direita, abaixo de qualquer conteúdo <RequestExample> na mesma página.
ResponseExample
<ResponseExample>

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

</ResponseExample>