Primeiros passos

Este guia cria um endpoint GET /hello, executa a aplicação e verifica a resposta.

1. Configure o ambiente

Crie .env na raiz do projeto:

ENVIRONMENT=development
APP_NAME=hello-colibri
APP_TYPE=service
CLOUD=none

Essas quatro variáveis são obrigatórias. Consulte Configuração para entender os valores.

2. Crie a aplicação

Crie main.go:

package main

import (
	"net/http"

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

type helloResponse struct {
	Message string `json:"message"`
}

var routes = []restserver.Route{
	{
		URI:    "hello",
		Method: http.MethodGet,
		Prefix: restserver.NoPrefix,
		Function: func(ctx restserver.WebContext) {
			ctx.JsonResponse(http.StatusOK, &helloResponse{
				Message: "Hello, Colibri!",
			})
		},
	},
}

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

O pacote raiz do módulo se chama colibri; por isso o import correto termina em colibri-sdk-go, sem /colibri.

3. Execute

go run .

O servidor usa a porta 8080 por padrão e também publica:

• GET /health: estado do serviço;
• GET /api-docs: arquivo ./docs/swagger.json, quando existente.

4. Teste

Em outro terminal:

curl --fail --silent http://localhost:8080/hello

Resposta:

{"message":"Hello, Colibri!"}

Se a porta estiver ocupada, adicione PORT=8081 ao .env e ajuste o curl.

O que aconteceu

1. InitializeApp() carregou a configuração e preparou os componentes básicos.
2. AddRoutes() registrou o endpoint.
3. ListenAndServe() configurou middlewares, rotas internas e iniciou o servidor.

Agora você pode explorar servidor web, banco de dados ou os exemplos completos.