Jamdesk Documentation logo

Exemplos de requisição e resposta

Aprenda a documentar APIs com os componentes RequestExample e ResponseExample, usando um fluxo prático de tickets de suporte da Acme.

GEThttps://jamdesk-docs.jamdesk.app/api/playground/demo/tickets/{ticket_id}

Use RequestExample e ResponseExample para mostrar o uso real da API junto às suas páginas de endpoint. Os componentes podem exibir vários idiomas, status de resposta e explicações inline.

Exemplo: recuperar um ticket de suporte

Este exemplo documenta o endpoint GET /tickets/{ticket_id} da API de suporte da Acme.

Requisição

Use os campos de parâmetro para descrever o que o endpoint espera. O exemplo de código fica na barra lateral direita.

ticket_idstringrequired

Identificador único do ticket, retornado quando o ticket foi criado.

curl -X GET https://api.acme.com/v1/tickets/tkt_9S8L2 \
  -H "Authorization: Bearer $ACME_TOKEN"

Resposta

Use os campos de resposta para documentar os atributos mais importantes retornados pela API.

idstringrequired

Identificador único do ticket.

statusstring

Status atual do ticket (open, pending ou resolved).

created_atstring

Timestamp ISO 8601 de quando o ticket foi criado.

{
  "id": "tkt_9S8L2",
  "customer_id": "cus_2X9W8",
  "subject": "Export stuck on step 3",
  "priority": "high",
  "status": "open",
  "created_at": "2026-02-04T16:12:00Z"
}

Dicas

  • Inclua pelo menos uma resposta de sucesso e uma resposta de erro.
  • Use identificadores e timestamps realistas para tornar os exemplos mais verossímeis.
  • Mantenha os payloads mínimos para que o leitor possa varrê-los rapidamente.

Páginas relacionadas

API Playground

Ative o teste interativo de API nas páginas de endpoint

Exemplo de OpenAPI

Veja uma página de endpoint gerada automaticamente

Componente Examples

Props do componente e regras de formatação

Componente Fields

Documente schemas de requisição e resposta