Gerar Aplicação a partir de Especificação OpenAPI

Seu objetivo é gerar uma aplicação completa e funcional a partir de uma especificação OpenAPI, utilizando as convenções e melhores práticas do framework ativo.

Requisitos de Entrada

1. Especificação OpenAPI: Forneça uma das seguintes opções:

   • Uma URL para a especificação OpenAPI (ex: https://api.example.com/openapi.json)
   • Um caminho de arquivo local para a especificação OpenAPI
   • O conteúdo completo da especificação OpenAPI colado diretamente

2. Detalhes do Projeto (se não estiverem na especificação):

   • Nome e descrição do projeto
   • Framework e versão de destino
   • Convenções de nomenclatura de pacotes/namespaces
   • Método de autenticação (se não especificado no OpenAPI)

Processo de Geração

Etapa 1: Analisar a Especificação OpenAPI

• Validar a especificação OpenAPI quanto à completude e correção
• Identificar todos os endpoints, métodos HTTP, esquemas de requisição/resposta
• Extrair requisitos de autenticação e esquemas de segurança
• Anotar relacionamentos e restrições de modelos de dados
• Sinalizar quaisquer ambiguidades ou definições incompletas

Etapa 2: Projetar a Arquitetura da Aplicação

• Planejar a estrutura de diretórios apropriada para o framework
• Identificar o agrupamento de controllers/handlers por recurso ou domínio
• Projetar a organização da camada de serviço para a lógica de negócios
• Planejar modelos de dados e relacionamentos de entidades
• Projetar a estratégia de configuração e inicialização

Etapa 3: Gerar Código da Aplicação

• Criar a estrutura do projeto com arquivos de configuração de build/pacote
• Gerar modelos/DTOs a partir dos esquemas OpenAPI
• Gerar controllers/handlers com mapeamentos de rotas
• Gerar a camada de serviço com a lógica de negócios
• Gerar a camada de repositório/acesso a dados, se aplicável
• Adicionar tratamento de erros, validação e logging
• Gerar código de configuração e inicialização

Etapa 4: Adicionar Arquivos de Suporte

• Gerar testes unitários apropriados para serviços e controllers
• Criar README com instruções de configuração e execução
• Adicionar arquivos .gitignore e modelos de configuração de ambiente
• Gerar arquivos de documentação da API
• Criar exemplos de requisições/testes de integração

Estrutura de Saída

A aplicação gerada incluirá:

project-name/
├── README.md                      # Setup and usage instructions
├── [build-config]                 # Framework-specific build files (pom.xml, build.gradle, package.json, etc.)
├── src/
│   ├── main/
│   │   ├── [language]/
│   │   │   ├── controllers/       # HTTP endpoint handlers
│   │   │   ├── services/          # Business logic
│   │   │   ├── models/            # Data models and DTOs
│   │   │   ├── repositories/      # Data access (if applicable)
│   │   │   └── config/            # Application configuration
│   │   └── resources/             # Configuration files
│   └── test/
│       ├── [language]/
│       │   ├── controllers/       # Controller tests
│       │   └── services/          # Service tests
│       └── resources/             # Test configuration
├── .gitignore
├── .env.example                   # Environment variables template
└── docker-compose.yml             # Optional: Docker setup (if applicable)

Melhores Práticas Aplicadas

• Convenções do Framework: Segue a nomenclatura, estrutura e padrões específicos do framework
• Separação de Responsabilidades: Camadas claras com controllers, services e repositories
• Tratamento de Erros: Tratamento abrangente de erros com respostas significativas
• Validação: Validação de entrada e validação de esquemas em toda a aplicação
• Logging: Logging estruturado para depuração e monitoramento
• Testes: Testes unitários para serviços e controllers
• Documentação: Documentação de código inline e instruções de configuração
• Segurança: Implementa autenticação/autorização da especificação OpenAPI
• Escalabilidade: Padrões de design suportam crescimento e manutenção

Próximos Passos

Após a geração:

1. Revise a estrutura do código gerado e faça personalizações conforme necessário
2. Instale as dependências de acordo com os requisitos do framework
3. Configure variáveis de ambiente e conexões de banco de dados
4. Execute os testes para verificar o código gerado
5. Inicie o servidor de desenvolvimento
6. Teste os endpoints usando os exemplos fornecidos

Perguntas a Fazer, se Necessário

• A aplicação deve incluir configuração de banco de dados/ORM, ou apenas dados em memória/mock?
• Você quer configuração Docker para conteinerização?
• A autenticação deve ser JWT, OAuth2, chaves de API ou autenticação básica?
• Você precisa de testes de integração ou apenas testes unitários?
• Alguma preferência específica de tecnologia de banco de dados?
• A API deve incluir exemplos de paginação, filtragem e ordenação?