Pular para o conteúdo principal
Versão: Em desenvolvimento — v0.2.3

Adicionar a um projeto existente

Você pode adotar o SDK por etapas. Comece pela inicialização e pelo módulo que resolve uma necessidade atual.

1. Instale a versão

go get github.com/colibriproject-dev/colibri-sdk-go@v0.2.2

2. Configure as variáveis obrigatórias

ENVIRONMENT=development
APP_NAME=my-existing-service
APP_TYPE=service
CLOUD=none

InitializeApp() procura automaticamente um .env no diretório de execução. Em produção, prefira variáveis injetadas pela plataforma.

3. Inicialize os componentes básicos

import colibri "github.com/colibriproject-dev/colibri-sdk-go"

func main() {
colibri.InitializeApp()
// Inicialização atual da aplicação.
}

O alias é opcional: o nome declarado pelo pacote raiz já é colibri.

4. Adote um módulo

Para migrar um servidor HTTP existente:

import "github.com/colibriproject-dev/colibri-sdk-go/pkg/web/restserver"

func main() {
colibri.InitializeApp()
restserver.AddRoutes(routes)
restserver.ListenAndServe()
}

Banco, cache, mensageria e storage exigem suas próprias funções Initialize(). Consulte o ciclo de vida.

Cuidados durante a migração

  • ListenAndServe() é bloqueante; chame-o depois de registrar rotas e middlewares.
  • Não inicialize módulos que o serviço não usa.
  • Preserve o context.Context entre handlers, casos de uso e infraestrutura.
  • Execute os testes existentes depois de cada módulo migrado.
  • Verifique a compatibilidade antes de atualizar a versão.