1. Propósito e Escopo
Este documento define todos os prompts, configurações de memória, transição entre estados e demais requisitos funcionais para o Agente de IA "Automação de Testes em Integrações de API", uma solução projetada para automatizar a execução de testes em integrações de API, garantindo que novas atualizações não impactem o funcionamento correto dos serviços. Essa documentação é um modelo de PRD ou Documento de Requisitos de Produto específicos para construção de Agentes de IA.
O objetivo principal é transformar o processo de execução de testes manuais, que são demorados e propensos a erros, em um fluxo automatizado e eficaz, assegurando a continuidade operacional dos serviços após atualizações.
2. Contexto e Problema
Cenário Atual
Atualmente, a execução de testes de integração de API é realizada de forma manual, o que consome tempo e está sujeito a erros humanos. Além disso, não há um sistema eficiente para garantir que novas atualizações de software não afetem negativamente o funcionamento dos serviços. Os principais problemas enfrentados são:
- Testes manuais demorados e propensos a erros em integrações de API.
- Risco de novas atualizações impactarem negativamente o funcionamento dos serviços.
- Falta de automação nos testes de integração contínua.
A ausência de um histórico de testes e a falta de notificações automáticas para as equipes responsáveis em caso de falhas são desafios adicionais que precisam ser abordados.
3. Impactos Esperados
A implementação deste agente de automação visa alcançar os seguintes resultados:
- Reduzir o tempo gasto em testes de integração em pelo menos 60%.
- Minimizar erros humanos durante o processo de teste.
- Garantir a estabilidade e a continuidade dos serviços após atualizações de software.
- Manter um histórico detalhado de todas as execuções de teste para análise e melhoria contínua.
- Notificar automaticamente as equipes responsáveis sobre falhas detectadas.
4. Visão Geral da Solução
O agente de IA para automação de testes em integrações de API executa testes automatizados para todas as integrações de API, verifica se atualizações impactam negativamente os serviços e mantém um histórico de testes para melhoria contínua. A seguir são detalhadas todas as regras de negócio e especificações funcionais necessárias para que esse agente atue como um assistente útil e autônomo na automação de testes de integrações de API.
A solução consiste em um fluxo de automação que inicia com a configuração dos parâmetros de teste e termina com a geração de relatórios e notificações automáticas para as equipes responsáveis.
| Agentes | Função Principal |
|---|---|
Agente de Execução de Testes de Integração de API (RF 1)
| Automatizar a execução de testes em integrações de API para garantir que novas atualizações não impactem negativamente os serviços. |
5. Protótipos
Para proporcionar uma visão clara e tangível da solução proposta, criamos protótipos interativos que demonstram tanto o fluxo de trabalho do agente quanto o resultado final que o cliente receberá. Explore os links abaixo para entender melhor a solução em ação.
6. Requisitos Funcionais
RF 1. Agente de Execução de Testes de Integração de API
1.1 Tarefa do Agente
Automatizar a execução de testes em integrações de API para garantir que novas atualizações não impactem negativamente os serviços.
1.2 Prompt ou Instruções do Agente
# 1. Contexto e explicações sobre inputs iniciais
Você está recebendo parâmetros de configuração dos testes e especificações das APIs a serem testadas.
# 2. Objetivo
Automatizar a execução de testes para todas as integrações de API e garantir que as novas atualizações não afetem negativamente o funcionamento dos serviços.
# 3. Regras que você deve seguir para gerar sua resposta
- Configure automaticamente os testes para todas as integrações de API, assegurando cobertura completa das funcionalidades.
- Valide se as novas atualizações impactaram negativamente os serviços, comparando resultados atuais com execuções anteriores.
- Registre e mantenha um histórico detalhado de todos os testes executados, incluindo data, hora, versão da API e resultados.
- Envie notificações automáticas para as equipes responsáveis em caso de falhas, detalhando o erro e sugerindo possíveis causas.
- Realize testes de regressão para garantir que as funcionalidades anteriores ainda operam como esperado após atualizações.
# 4. Exemplo de Output que você deve produzir
**Relatório de Testes de Integração de API**
- **Data e Hora:** 18/11/2025 08:38
- **Versão da API:** v2.1.0
- **Resultados:**
- **Testes Bem-sucedidos:** 95
- **Falhas:** 5
- **Detalhes das Falhas:**
1. Falha na autenticação (Erro 401)
2. Tempo de resposta superior ao esperado
- **Histórico de Execuções:**
- Execução anterior (v2.0.9): 100% sucesso
- **Notificações Enviadas:** Sim 1.3 Configurações do Agente
1.3.1 Especificação do Input
- Mecanismo de Acionamento: Este agente é o ponto de partida do fluxo e deve ser acionado pelo envio de parâmetros de configuração dos testes via API. Na fase de testes, o fluxo será iniciado pelo envio manual dos dados, que serão enviados para o agente diretamente por upload na interface da Prototipe AI, para acelerar o processo de validação.
- Tipo do input: O input inicial para o fluxo é um conjunto de parâmetros de configuração e especificações das APIs a serem testadas.
-
Formatos Suportados: Esse agente deve ser capaz de receber inputs nos formatos:
.jsone.yaml. - Número de caracteres esperado: Este agente deve ter capacidade para processar um input de até 50.000 caracteres.
1.3.2 Especificação do Output
- Formato de output: O output deve ser um relatório detalhado em **Markdown**, incluindo data, hora, versão da API, resultados dos testes, histórico de execuções e notificações enviadas.
-
Exemplo de Estrutura de Output:
**Relatório de Testes de Integração de API** - **Data e Hora:** 18/11/2025 08:38 - **Versão da API:** v2.1.0 - **Resultados:** - **Testes Bem-sucedidos:** 95 - **Falhas:** 5 - **Detalhes das Falhas:** 1. Falha na autenticação (Erro 401) 2. Tempo de resposta superior ao esperado - **Histórico de Execuções:** - Execução anterior (v2.0.9): 100% sucesso - **Notificações Enviadas:** Sim - Número de caracteres esperado: O relatório final deve ter um tamanho estimado em torno de 3.000 caracteres, podendo variar conforme o número de APIs testadas e os resultados obtidos.
1.3.3 Parâmetros de Geração
- Modelo: GPT-5
- Temperatura: 0.6
1.3.4 Ferramentas do Agente
- Documentos: Não consulta documentos externos.
- Calculadora: Não utiliza.
- Busca Online: Não utiliza.
- Sistemas Externos: Não se conecta a sistemas externos.
1.3.5 Memória
- Visibilidade das Instruções (Prompt): As instruções deste agente não devem ser visíveis para nenhum agente subsequente.
- Visibilidade da Resposta: A resposta gerada por este agente não é visível para outros agentes, pois é o produto final do fluxo.
1.3.6 Regras de Orquestração e Transição
A execução deste agente finaliza o fluxo, gerando um relatório que é disponibilizado para as equipes responsáveis.