server

Server Package

The server package provides a simple and configurable HTTP server implementation with support for graceful shutdown, different operating modes, and configurable logging levels.

Quick Start

package main

import (
    "net/http"
    "your-project/server"
)

func main() {
    // Define a simple handler
    handler := func(w http.ResponseWriter, r *http.Request) {
        w.Write([]byte("Hello, World!"))
    }

    // Start the server
    server.Start(server.Options{
        Host:    "localhost",
        Port:    "8080",
        URL:     "http://localhost:8080",
        Handler: handler,
        Mode:    server.ProductionMode,
        LogLevel: server.LogLevelInfo,
    })
}

Features

• Configurable Server Options: Set host, port, URL, handler, mode, and log level
• Multiple Operating Modes: Production and testing modes
• Configurable Logging: Debug, info, error, and none log levels
• Graceful Shutdown: Handles OS signals (SIGINT, SIGTERM) for clean server termination
• Colorized Logging: Uses cfmt for better visibility of server status

Configuration Options

The Options struct provides the following configuration options:

Log Levels

The package supports the following log levels:

• LogLevelDebug: Detailed debugging information
• LogLevelInfo: General information about server operations
• LogLevelError: Error messages only
• LogLevelNone: No logging

Operating Modes

• ProductionMode: Standard production mode with normal error handling
• TestingMode: Special mode for testing with different error handling

Testing

The package includes a test file (start_test.go) that demonstrates how to test the server functionality, including:

• Starting the server
• Making requests to verify it's running
• Gracefully shutting down the server
• Verifying the server has shut down

Dependencies

• github.com/mingrammer/cfmt: Colorized formatting for logs

Advanced Usage

Example with Router

package main

import (
    "fmt"
    "net/http"
    "your-project/router"
    "your-project/server"
)

func main() {
    // Create a new router
    r := router.NewRouter()
    
    // Add routes to the router
    r.AddRoute(router.NewRoute().
        SetMethod("GET").
        SetPath("/").
        SetHandler(func(w http.ResponseWriter, r *http.Request) {
            fmt.Fprint(w, "Welcome to the homepage!")
        }))
    
    r.AddRoute(router.NewRoute().
        SetMethod("GET").
        SetPath("/api/users").
        SetHandler(func(w http.ResponseWriter, r *http.Request) {
            fmt.Fprint(w, "User list API endpoint")
        }))
    
    // Create an API group with middleware
    apiGroup := router.NewGroup().
        SetPrefix("/api").
        AddBeforeMiddlewares([]router.Middleware{
            func(next http.Handler) http.Handler {
                return http.HandlerFunc(func(w http.ResponseWriter, r *http.Request) {
                    // Add API key validation or other middleware logic
                    w.Header().Set("X-API-Version", "1.0")
                    next.ServeHTTP(w, r)
                })
            },
        })
    
    // Add routes to the API group
    apiGroup.AddRoute(router.NewRoute().
        SetMethod("GET").
        SetPath("/products").
        SetHandler(func(w http.ResponseWriter, r *http.Request) {
            fmt.Fprint(w, "Products API endpoint")
        }))
    
    // Add the group to the router
    r.AddGroup(apiGroup)
    
    // Start the server with the router as the handler
    server.Start(server.Options{
        Host:    "localhost",
        Port:    "8080",
        URL:     "http://localhost:8080",
        Handler: r.ServeHTTP,
        Mode:    server.ProductionMode,
        LogLevel: server.LogLevelInfo,
    })
}

License

This package is part of the main project and subject to its license terms.