Scanner OpenAPI no Desktop
Gera OpenAPI 3.1 a partir da pasta do seu projeto backend: varredura estrutural rápida com inferência opcional de IA local.
Gera um arquivo OpenAPI 3.1 (openapi.json) a partir da pasta do seu projeto backend, sem precisar executar a API nem escrever o spec manualmente.
O que o scanner faz
- Explora: Localiza arquivos com rotas HTTP (controllers,
routes/,handlers/,Program.cs, etc.). - Extrai: Obtém métodos, paths e DTOs/modelos para
components.schemas. - Gera: Cria
openapi.jsoncom um resumo da análise. - Faz upload: Permite enviar o arquivo diretamente para um workspace do Capydox web.
O fluxo padrão é a varredura estrutural: rápida, apenas CPU, sem necessidade de modelo de IA.
Guia rápido de uso
- Abrir: Vá para Escanear OpenAPI no menu lateral.
- Pasta: Clique em Escolher pasta do projeto e selecione a raiz do repositório.
- Analisar: Clique em Analisar API e aguarde o cartão de resultado aparecer.
- Resultado: Revise o resumo e copie ou importe o
openapi.jsongerado. - Upload (opcional): Selecione um workspace e clique em Enviar OpenAPI.
Stacks compatíveis
O motor reconhece automaticamente os seguintes ecossistemas:
- Java: Spring Boot
- PHP: Laravel
- Node: Express, Fastify, NestJS, Hono
- Python: Django REST, FastAPI, Flask
- Go: Gin, Echo, Chi
- Rust: Axum, Actix
- C#: ASP.NET Core
Opções avançadas: Inferir esquemas com IA
| Característica | Varredura estrutural | + IA opcional |
|---|---|---|
| Rotas HTTP | Sim | Sim |
| DTOs/Modelos | Se existirem no repo | Sim + amostra extra inferida |
| Modelo (~4GB) | Não necessário | Obrigatório |
| Privacidade | Tudo local | Ver privacidade |
Boas práticas
- Aponte para a pasta raiz da API, não para o monorepo completo.
- Use nomes de arquivo padrão (
*Controller.java,routes/*.js, etc.) para facilitar a detecção. - A IA deve ser ativada apenas se tipos estiverem faltando e você não tiver fontes nativas (como SpringDoc).
Limpeza
Limpar artefatos permite excluir análises antigas (mais de 7 dias) salvas no disco local.