Especificação técnica de endpoint REST
Transforme uma necessidade de produto em contrato de API, validações e casos de erro.
Reputação
Avalie a utilidade deste prompt
O ranking combina reações positivas, visualizações únicas e volume mínimo de avaliações para evitar que um prompt suba só por tráfego.
Quando usar
Definir endpoint antes de implementar.
Guia de uso profissional
Este prompt foi pensado para profissionais de desenvolvedor que precisam executar planejamento no contexto de tecnologia. Ele transforma a tarefa "Especificação técnica de endpoint REST" em um roteiro de trabalho com contexto, restrições e formato de saída definidos.
Definir endpoint antes de implementar. Para evitar respostas superficiais, a estrutura força a IA a explicar premissas, organizar prioridades e entregar algo que possa ser revisado por uma pessoa antes do uso final.
A versão principal foi escrita para Gemini em nível básico. Ajuda em planejamento, comparação de alternativas e organização de informações quando há várias frentes em paralelo. O nível básico prioriza clareza e execução rápida. É indicado quando você quer uma primeira versão organizada antes de aprofundar.
Antes de enviar para a IA
- Inclua linguagem, framework, trecho de código, erro observado, versão das bibliotecas e restrições de arquitetura.
- Informe objetivo final, prazo, restrições, dependências e riscos conhecidos.
- Peça fases com entregáveis, critérios de aceite e pontos de decisão.
- Inclua o que não deve ser alterado para evitar escopo aberto demais.
Como avaliar a resposta
- O plano começa por validação e reduz risco antes de mudanças irreversíveis.
- Cada etapa tem saída concreta e responsável provável.
- Rollback, comunicação e monitoramento aparecem quando o contexto exige.
Erros comuns ao usar
- Confundir cronograma com plano técnico.
- Ignorar dados legados, aprovação de stakeholders e janelas operacionais.
- Planejar sem critério de sucesso verificável.
Ajustes recomendados
- No Gemini, especifique formato de saída e peça uma síntese executiva antes da lista detalhada de tarefas ou achados.
- Revise termos específicos do seu contexto e remova qualquer sugestão que pareça genérica demais para a situação.
- Troque exemplos genéricos por dados do seu caso real e mantenha nomes, números e limitações em campos separados.
Prompt-base
Atue como especialista em Desenvolvedor no setor de Tecnologia. Sua função é ajudar em "Especificação técnica de endpoint REST".
Contexto:
{{descreva_o_contexto}}
Dados disponíveis:
{{cole_os_dados_ou_texto_aqui}}
Objetivo:
Definir endpoint antes de implementar.
Regras:
- Não invente dados, leis, métricas, documentos ou resultados.
- Quando faltar informação, marque como [PENDENTE].
- Priorize recomendações aplicáveis ao trabalho real.
- Separe diagnóstico, execução sugerida, riscos e próximos passos.
- Use linguagem objetiva em português do Brasil.
Entregue:
1. Resumo do problema.
2. Pontos críticos.
3. Sugestão estruturada.
4. Checklist de validação.
5. Próxima ação recomendada.Exemplo de entrada
Contexto de Desenvolvedor para especificação técnica de endpoint rest, com dados reais colados pelo usuário e restrições do projeto.
Exemplo de saída esperada
Saída esperada: análise estruturada para planejamento, com pendências explícitas, riscos priorizados e próximos passos práticos.
Tags
Cuidados e limites
Não cole secrets, tokens, chaves privadas, dados de clientes ou logs com informação sensível. Revise qualquer sugestão antes de aplicar em produção.