server

package
v0.0.0 Latest Latest
Warning

This package is not in the latest version of its module.

Go to latest
Published: May 8, 2026 License: MIT Imports: 9 Imported by: 0

Documentation

Index

Constants

This section is empty.

Variables

This section is empty.

Functions

func NormalizeBasePath

func NormalizeBasePath(value string) string

Types

type App

type App struct {
	// contains filtered or unexported fields
}

func New

func New(cfg Config, debug bool) *App

func (*App) Engine

func (a *App) Engine() *gin.Engine

func (*App) ListenAndServe

func (a *App) ListenAndServe() error

func (*App) RegisterBuiltInMiddlewares

func (a *App) RegisterBuiltInMiddlewares()

func (*App) RegisterMiddlewares

func (a *App) RegisterMiddlewares(middlewares []MiddlewareProvider)

func (*App) RegisterRoutes

func (a *App) RegisterRoutes(registrars []RouteProvider)

func (*App) Routes

func (a *App) Routes() *gin.RouterGroup

func (*App) Shutdown

func (a *App) Shutdown(ctx context.Context) error

type Config

type Config struct {
	BasePath        string                 `yaml:"base-path"`
	Port            string                 `yaml:"port"`
	ReadTimeout     string                 `yaml:"read-timeout"`
	WriteTimeout    string                 `yaml:"write-timeout"`
	RequestID       bool                   `yaml:"request-id"`
	AccessLog       bool                   `yaml:"access-log"`
	RecoveryLog     bool                   `yaml:"recovery-log"`
	SecurityHeaders bool                   `yaml:"security-headers"`
	CORS            *middleware.CORSConfig `yaml:"cors"`
	Binding         binding.Config         `yaml:"binding"`
}

func DefaultConfig

func DefaultConfig() Config

type MiddlewareProvider

type MiddlewareProvider interface {
	RegisterMiddlewares(e *gin.Engine)
}

type RouteProvider

type RouteProvider interface {
	RegisterRoutes(r *gin.RouterGroup)
}

Directories

Path Synopsis

Jump to

Keyboard shortcuts

? : This menu
/ : Search site
f or F : Jump to
y or Y : Canonical URL