Escrever uma referência de API pronta para uso
Prompt que transforma código e exemplos em uma referência por endpoint com códigos de erro e chamadas que funcionam. Cole-o na ferramenta de IA que preferir, que então escreve a referência da API.
- Tipo
- Prompt
- Nível
- Intermediário
- Tempo
- cerca de 10 min
Os resultados dependem da ferramenta, do modelo e do que você digitar.
Prévia do resultado
Exemplo: escrito pela nossa redação, não é uma resposta real de IA.
## POST /pedidos Cria um pedido. | Campo | Tipo | Obrigatório | Observação | | cliente_id | texto | sim | de GET /clientes | | itens | lista | sim | pelo menos 1 | | cupom | texto | não | maiúsculas | Erros: 409 = cupom já usado → reenviar sem cupom Pergunta em aberto: o limite de 100 chamadas por minuto vale por chave ou por conta?
Preencher
O que você digita fica nesta janela do navegador. Não armazenamos nem enviamos nada.
- API REST de uma loja virtual
- API interna entre dois serviços
- API para empresas parceiras
- API de webhooks
- API GraphQL
- código-fonte das rotas
- um arquivo OpenAPI existente
- uma coleção de chamadas de exemplo
- documentação antiga em texto
- só anotações da equipe
- equipes de desenvolvimento de clientes
- pessoas novas na própria equipe
- empresas parceiras sem conhecimento prévio
- equipe de suporte
- equipe de frontend interna
Seu prompt
Você editou o prompt. As mudanças nos campos acima não o substituem mais.
Isto é uma instrução para uma IA, ainda não o resultado.
Onde este prompt funciona
Estas ferramentas de IA combinam com este prompt:
Como usar
- Preencha os campos ou toque em uma sugestão. Deixe de fora nomes, endereços e outros dados pessoais.
- Copie o prompt pronto para a ferramenta de IA que preferir.
- Entregue só a referência a alguém que não conhece a API. Se a pessoa fizer a primeira chamada com sucesso sem perguntar nada, a referência está boa.
Por que funciona?
Referências raramente falham por falta de endpoints, e sim por códigos de erro ausentes, campos obrigatórios pouco claros e exemplos que não rodam. Uma estrutura fixa por endpoint e perguntas em aberto em vez de respostas chutadas as tornam confiáveis.
Dicas
- Substitua chaves, tokens e dados de clientes nos exemplos por marcadores antes de colocar material na ferramenta de IA.