Como criar exemplos de API a partir da documentação fornecida
Exemplos de API ajudam a relacionar a descrição de um endpoint com uma estrutura concreta de requisição e resposta. A precisão depende do método, dos campos e dos requisitos de autenticação realmente fornecidos.
Comece com o material certo.
- O que você fornece
- uma página de referência de API com método, caminho e esquema visíveis.
- O resultado pretendido
- Salve exemplos de requisições com credenciais fictícias para substituir e apenas os campos documentados.
Como funciona o fluxo de trabalho.
Use o esquema documentado e valores de exemplo claramente fictícios. Preserve campos obrigatórios e opcionais e use marcadores de posição para credenciais, em vez de incluir segredos reais.
O que conferir no resultado.
Valide o exemplo no ambiente pertinente antes de publicá-lo como testado. Uma requisição ou resposta plausível não comprova que o endpoint exista ou se comporte como mostrado.
Leia o texto como um resultado editável e confira-o com a fonte. Preserve referências, nomes e condições importantes ao copiá-lo para outro documento ou mensagem.
Aprenda com o exemplo resolvido.
Use o exemplo para download para entender o formato do resultado. Compare-o com o exemplo de origem e aplique as mesmas verificações factuais ao material da sua própria tarefa.
O exemplo fornecido é ilustrativo. Não é uma execução registrada com seus dados.
Baixe o exemplo ↓Use com seu próprio material.
- Abra a fonte com a qual quer trabalhar e ative o WebAct nessa aba.
- Copie a tarefa da seção principal, acrescente os campos ou preferências necessários e revise as ações propostas.
- Compare o primeiro resultado com a fonte. Peça uma correção ou um ajuste específico quando necessário.