feat: Implement initial backend structure with API, WebSocket, core models, services, and documentation, alongside dependency and gitignore updates.
This commit is contained in:
1 parent
f82191dd83
commit
7710be86a6
29 files changed
+3927
-1301
No files matched your search
@@ -0,0 +1,66 @@
|
||||
# Documentação do OllaHubBackend
|
||||
|
||||
Esta pasta contém a documentação técnica completa das APIs do OllaHubBackend.
|
||||
|
||||
## Documentos Disponíveis
|
||||
|
||||
### [API.md](./API.md)
|
||||
Documentação técnica completa de todas as APIs:
|
||||
- Visão geral e configuração
|
||||
- Autenticação JWT
|
||||
- Todos os endpoints (Sistema, Ollama, Modelos, Criptografia, Usuários, WebSocket)
|
||||
- Modelos de dados e schemas
|
||||
- Tratamento de erros
|
||||
- Variáveis de ambiente
|
||||
- Exemplos básicos de uso
|
||||
|
||||
### [API_EXAMPLES.md](./API_EXAMPLES.md)
|
||||
Exemplos práticos e casos de uso:
|
||||
- Cliente TypeScript/JavaScript completo
|
||||
- Casos de uso detalhados
|
||||
- Hooks React para WebSocket
|
||||
- Tratamento robusto de erros
|
||||
- Validação de dados
|
||||
- Cache e monitoramento
|
||||
- Boas práticas
|
||||
|
||||
### [OLLAMA.md](./OLLAMA.md)
|
||||
Documentação específica sobre integração com Ollama (se existir).
|
||||
|
||||
## Início Rápido
|
||||
|
||||
1. **Leia primeiro**: [API.md](./API.md) para entender a estrutura geral
|
||||
2. **Veja exemplos**: [API_EXAMPLES.md](./API_EXAMPLES.md) para implementações práticas
|
||||
3. **Teste interativamente**: Acesse `http://127.0.0.1:8080/docs` (Swagger UI)
|
||||
|
||||
## Estrutura da API
|
||||
|
||||
### Versões
|
||||
- **V1 (Legado)**: Endpoints em `main.rs`
|
||||
- **V2 (Modular)**: Endpoints organizados - **Recomendado**
|
||||
|
||||
### Categorias
|
||||
- **Sistema**: Health checks
|
||||
- **Ollama**: Instalação e verificação
|
||||
- **Modelos**: Listagem e instalação
|
||||
- **Criptografia**: AES-256-GCM
|
||||
- **Usuários**: CRUD completo
|
||||
- **WebSocket**: Eventos em tempo real
|
||||
|
||||
## Links Úteis
|
||||
|
||||
- **Swagger UI**: `http://127.0.0.1:8080/docs`
|
||||
- **Health Check**: `http://127.0.0.1:8080/health`
|
||||
- **Base URL**: `http://127.0.0.1:8080`
|
||||
|
||||
## Contribuindo
|
||||
|
||||
Ao adicionar novos endpoints ou modificar APIs existentes:
|
||||
1. Atualize [API.md](./API.md) com a documentação do endpoint
|
||||
2. Adicione exemplos em [API_EXAMPLES.md](./API_EXAMPLES.md) se aplicável
|
||||
3. Mantenha a consistência com o formato existente
|
||||
|
||||
---
|
||||
|
||||
**Última Atualização**: 2024
|
||||
|
||||
Reference in new issue
Block a user