Exemplo de projeto / Stockroom API
Um backend do qual outra aplicação pode depender
O resultado tem um contrato documentado e falhas previsíveis. Uma lista de endpoints sem validação, testes ou configuração de execução não é uma API pronta.
Mantenha os registros de produtos e movimentações persistentes, escolhendo como adicionar um banco de dados gerenciado à API.
/products
Listar e filtrar produtos.
/movements
Validar e registrar alterações de estoque.
/inventory
Retorne o estoque atual calculado.
/health
Informe a saúde do processo sem expor dados privados.
Antes de enviar o prompt
Escreva o contrato antes de gerar handlers
Comece pelos consumidores e recursos. Isso dá à IA uma razão para cada rota, campo, código de status e permissão, em vez de produzir uma interface CRUD genérica.
Consumidor conhecido
Identifique a aplicação web, o aplicativo móvel, a ferramenta interna ou o parceiro que chamará a API.
Propriedade dos recursos
Indique se os registros são públicos ou pertencem a um usuário, equipe ou serviço.
Contrato de falhas
Escolha um único formato seguro de erro JSON e códigos de resposta significativos antes de implementar.
Evidências de execução
Mantenha juntos os requisitos de inicialização, porta, saúde, banco de dados, segredos, migração e testes básicos.
Se precisar comparar stacks antes de enviar o prompt, revise o Guias de implantação de API.
Projete o contrato
Peça rotas, dados, permissões e testes antes do código
Este prompt faz o agente examinar a stack existente e mostrar primeiro o contrato da API. Substitua os valores entre colchetes e revise a resposta como o documento de trabalho da API.
Ajude-me a planejar uma API REST estruturada para produção neste espaço de trabalho Adios. Não edite arquivos ainda.
A API:
- Nome: [NOME DA API]
- Consumidor: [APLICAÇÃO WEB, APLICATIVO MÓVEL, FERRAMENTA INTERNA OU PARCEIRO]
- Recurso principal: [RECURSO]
- Ações principais: [CRIAR, LISTAR, LER, ATUALIZAR OU OUTRAS AÇÕES]
- Autenticação: [NENHUMA PARA UMA DEMONSTRAÇÃO PÚBLICA, TOKEN DE USUÁRIO OU CHAVE API DE SERVIÇO]
- Banco de dados: [BANCO ATUAL DO PROJETO OU POSTGRES]
Antes de propor mudanças, examine o repositório, o framework atual, o gerenciador de pacotes, os testes, a rota de saúde, a configuração de ambiente e adios.yaml.
Retorne:
1. a tabela de rotas com métodos e códigos de resposta;
2. os formatos de requisição e resposta;
3. o comportamento da validação e dos erros;
4. o modelo de dados e a abordagem de migrações;
5. os limites de autenticação e autorização;
6. considerações sobre limites de requisições ou abusos;
7. testes automatizados e exemplos manuais com curl; e
8. a configuração necessária no Adios de ambiente de execução, saúde, banco de dados e segredos.
Prefira a stack existente. Explique qualquer nova dependência. Aguarde minha aprovação antes de editar.O que uma resposta útil contém
- Uma tabela de rotas em vez de uma lista de desejos de funcionalidades
- Formatos de requisição, resposta, validação e erro
- Um modelo definido de propriedade e autorização
- Requisitos de ambiente de execução e testes antes de editar
Implementar o contrato
Crie a API preservando a stack que já funciona
Depois de aprovar o contrato, use este prompt para implementá-lo com erros consistentes, acesso parametrizado aos dados, testes e exemplos executáveis.
Crie a API REST a partir do plano que aprovei.
Requisitos:
- Mantenha a linguagem, o framework, o gerenciador de pacotes e os arquivos de implantação Adios existentes.
- Preserve um endpoint de saúde leve e sem autenticação, que não exponha dados privados.
- Valide todas as entradas externas e retorne um único formato consistente de erro JSON.
- Aplique autenticação e autorização no servidor quando o plano exigir.
- Use acesso parametrizado ao banco de dados pela camada de dados já estabelecida no projeto.
- Adicione migrações reversíveis se este repositório usar migrações.
- Nunca inclua credenciais diretamente no código. Faça referência aos valores de banco de dados e autenticação pelo nome da variável de ambiente.
- Adicione documentação concisa da API e exemplos de requisição executáveis.
- Adicione testes para o fluxo normal, entradas inválidas, registros ausentes, acesso não autorizado e um cenário de falha do banco de dados que possa ser testado com segurança.
- Execute o formatador, o linter, os testes e o comando de compilação de produção já usados pelo projeto.
Ao terminar, forneça a tabela de rotas, os arquivos alterados, os resultados dos testes, a configuração Adios necessária e os comandos exatos que posso executar em Preview. Não implante em produção.O que uma resposta útil contém
- Handlers que correspondem à tabela de rotas aprovada
- Validação consistente e comportamento de erro
- Testes de sucesso, falha e controle de acesso
- Requisições para Preview prontas para copiar
Questione as suposições
Teste entradas malformadas, limites de acesso e requisições repetidas
Uma requisição no fluxo normal prova pouco. Este prompt de revisão verifica o contrato pela perspectiva de um cliente desconhecido ou não confiável.
Revise esta API como se um cliente desconhecido fosse chamá-la. Corrija apenas problemas verificados e não implante.
Verifique:
- as rotas usam os métodos HTTP e códigos de status previstos;
- entradas malformadas, ausentes, grandes demais e inesperadas são recusadas com segurança;
- a autenticação não pode ser contornada e um cliente não pode acessar os dados protegidos de outro;
- respostas de erro não expõem stack traces, segredos, detalhes do banco de dados ou caminhos internos;
- requisições repetidas se comportam com segurança quando a idempotência é necessária;
- gravações no banco de dados e migrações são consistentes;
- a documentação da API e os exemplos de requisição correspondem à implementação;
- as verificações de saúde continuam leves;
- os logs são úteis sem registrar credenciais ou corpos de requisição sensíveis; e
- todas as verificações de formatação, lint, testes e compilação passam.
Retorne uma tabela de verificações e evidências, as requisições exatas que devo executar em Preview e qualquer risco restante.O que uma resposta útil contém
- Testes negativos, além de respostas 200
- Sem detalhes internos em erros públicos
- Documentação verificada em relação à implementação
- Uma lista explícita de riscos remanescentes
Alinhe o código-fonte ao ambiente de execução
Compare o contrato da API com o contrato de implantação Adios
O prompt final verifica se código-fonte, migração, comando de inicialização, porta, caminho de saúde, dependências, segredos e testes básicos descrevem a mesma versão.
Prepare esta API para uma revisão de implantação Adios. Não implante até que eu aprove.
Confirme o comando de inicialização, o host e a porta de escuta, o caminho de saúde, os nomes das variáveis de ambiente necessárias, a dependência do banco de dados, o comando de migração e a rota pública esperada. Compare tudo com adios.yaml e informe qualquer divergência.
Depois, forneça:
1. os resultados finais das verificações automatizadas;
2. cinco requisições seguras de teste básico para a URL de Preview;
3. uma nota de reversão ou recuperação para uma migração em falha;
4. os segredos que devo configurar pelo Adios, fora do código-fonte; e
5. uma verificação após a implantação cobrindo saúde, logs, autenticação e um ciclo de gravação e leitura.
Pare para obter minha aprovação antes da implantação em produção.O que uma resposta útil contém
- Sem desencontro entre processo e adios.yaml
- Testes básicos seguros em Preview e produção
- Uma nota sobre recuperação de migrações
- Uma pausa explícita antes da implantação
Testar o resultado
Uma compilação bem-sucedida é o início da revisão
Abra Preview e percorra você mesmo os fluxos importantes. Peça evidências ao agente, mas não confunda o resumo dele com a sua aprovação.
Contrato
- Cada rota documentada, método, código de status e campo corresponde à implementação.
- Entradas malformadas e inesperadas retornam o mesmo formato seguro de erro JSON.
- Paginação, filtros e ordenação se comportam de forma previsível quando presentes.
Limite de confiança
- Credenciais ausentes, inválidas, expiradas ou de outro proprietário são recusadas com segurança.
- Um erro público não contém stack trace, segredos, detalhes SQL ou caminhos internos.
- Os logs omitem credenciais e corpos de requisição sensíveis desnecessários.
Ambiente de execução
- O processo escuta no host e na porta declarados.
- Migrações, saúde, formatação, lint, testes e verificações de compilação passam.
- Um teste básico de gravação e leitura passa em Preview e após a implantação.
Etapa de aprovação humana
Publique o contrato da API junto com suas evidências
Trate a tabela de rotas, as migrações, os nomes das variáveis de ambiente, o caminho de saúde, os logs e as requisições de teste básico como parte da versão. Aprove somente quando corresponderem à versão em execução em Preview.
hospedar e implantar a API pronta criada com IA- 01Execute as requisições seguras para Preview e compare-as com a documentação.
- 02Confirme as instruções de migração e recuperação do banco de dados para esta versão.
- 03Configure os segredos nomeados no Adios e mantenha seus valores fora do código-fonte.
- 04Verifique as configurações de inicialização, porta, saúde e dependências em adios.yaml.
- 05Aprove a versão e repita as verificações de saúde, autenticação e um ciclo de gravação e leitura.
Perguntas antes de começar
O que este guia promete e seus limites
Este guia cria uma API de IA ou usa IA para criar minha API?
O guia usa o agente de IA Adios para criar o backend da sua aplicação. A API de exemplo gerencia dados de estoque; não chama um modelo de linguagem nem expõe uma API de modelo de IA.
Qual framework de backend devo usar?
Prefira o framework já usado no repositório. Se estiver começando do zero, escolha uma stack que a equipe possa manter, com convenções claras de validação, testes, migração e execução. O prompt pede ao agente que explique qualquer nova dependência.
Um endpoint de saúde de API deve exigir autenticação?
Um endpoint de saúde do processo costuma ser leve e sem autenticação para que a plataforma possa verificá-lo, mas não deve expor segredos, registros privados, credenciais de dependências ou detalhes internos de diagnóstico.
Como saber se uma API gerada por IA pode ser implantada com segurança?
Não dependa apenas da geração. Revise o contrato, execute testes positivos e negativos, verifique autorização e erros, examine o tratamento de segredos, aplique migrações com segurança, teste Preview e aprove você mesmo a versão candidata exata.