RVM.DocForge
Gera documentacao automatica de repositorios C# usando Roslyn, com 7 formatos de saida e snapshots historicos.
Visao geral
RVM.DocForge e um servico API que analisa automaticamente repositorios C# e gera documentacao abrangente. Utiliza Roslyn para analise estatica de codigo, extrai endpoints de API, entidades de dominio e servicos, e entao gera multiplos formatos de documentacao: README, API Reference, Entity Schema, Architecture Overview, Dependency Graph, Service Catalog e Full Documentation. O sistema persiste snapshots de analise e documentos gerados em PostgreSQL para rastreamento historico.
Funcionalidades
- Analise automatizada de repositorios usando Roslyn (syntax tree parsing)
- Geracao de documentacao em 7 formatos: README, API Reference, Entity Schema, Architecture Overview, Dependency Graph, Service Catalog, Full Documentation
- Rastreamento de snapshots com historico de analises
- Extracao de endpoints de API com rotas, metodos HTTP e parametros
- Descoberta de entidades (classes, records, structs, enums) com propriedades
- Catalogo de servicos com assinaturas de metodos e lifetime de DI
- Geracao de Markdown com Markdig
- Autenticacao por API Key com rate limiting por role
Tecnologias
Padroes & arquitetura
Endpoints REST
| Method | Path | Descricao |
|---|---|---|
| GET | /api/projects | Listar projetos |
| POST | /api/projects | Criar projeto |
| POST | /api/analysis/{projectId} | Analisar repositorio |
| GET | /api/analysis/snapshots/{id} | Detalhes do snapshot |
| POST | /api/documents/generate | Gerar documentacao |
| GET | /api/documents/{id}/raw | Markdown bruto |