Core

A Go framework for rapid API development, built on top of Fiber, facilitating quick prototyping and deployment of web services.

Overview

Core is a Go framework designed to streamline API development by providing a robust foundation for building web services. Leveraging the Fiber framework, Core simplifies the setup and management of routes, middleware, and services, enabling developers to focus on business logic rather than boilerplate code. With built-in support for configuration management, database integration, and profiling tools, Core accelerates the development process and enhances application performance.


package main

import (
    core "github.com/sphireinc/core/v1"
)

var App = core.New()

func main() {
    // Define routes
    App.Router.Get("/hello", helloHandler)
    App.Router.Get("/goodbye", goodbyeHandler)

    // Start the application
    App.Run()
}

// Handler for the /hello route
func helloHandler(ctx *core.Context) error {
    body := core.Res{
        Body:       []byte(`{"message": "Hello, World!"}`),
        BodyString: "Hello, World!",
    }
    return core.HandleResponseJSON(ctx, body.Byte(), App.S.OK)
}

// Handler for the /goodbye route
func goodbyeHandler(ctx *core.Context) error {
    body := core.Res{
        Body:       []byte(`{"message": "Goodbye, World!"}`),
        BodyString: "Goodbye, World!",
    }
    return core.HandleResponseJSON(ctx, body.Byte(), App.S.OK)
}

API Definition

STRUCTConfig

The central configuration struct for initializing and managing the Core application.

FUNCTIONNew() Config

Initializes a new instance of the Core Config struct, loading environment-specific settings and preparing services.

FUNCTIONRun() error

Starts the Core application, making it listen on the designated address and port as specified in the configuration.

STRUCTRouter

Provides routing capabilities for defining HTTP endpoints and associating them with handler functions.

FUNCTIONHandleResponseJSON(ctx *Context, body []byte, status int) error

Sends a JSON response to the client with the specified body and HTTP status code.