gins

Documentation

Index

• type Config
  • func (g *Config) NewEngine() (*gin.Engine, gin.IRouter)
  • func (g *Config) NewOpenAPI() *openapi.Openapi
  • func (c *Config) NewServer() *Server
  • func (g *Config) TryServeFiles(sr StaticRoute) gin.HandlerFunc
• type ConfigSection
• type Handler
• type OpenAPIServer
• type Request
• type Response
• type Route
  • func (r Route) Use(h Security) Route
• type Security
• type Server
  • func GetServer(c *ioc.Container) *Server
  • func GetServerByConfig(configSection ConfigSection, c *ioc.Container) *Server
  • func (s *Server) Register(services ...*Service)
  • func (s *Server) Run(ctx context.Context)
  • func (s *Server) SetSecuritySchemes(schemes openapi.SecuritySchemes)
• type Service
• type StaticRoute

Types

type Config

type Config struct {
	ApiTitle     string          `mapstructure:"api_title"`   // for openapi
	ApiVersion   string          `mapstructure:"api_version"` // for openapi
	ApiServers   []OpenAPIServer `mapstructure:"api_servers"` // for openapi
	HttpPort     int             `mapstructure:"http_port"`
	GinMode      string          `mapstructure:"gin_mode"`
	Log          bool            `mapstructure:"log"`
	EnableCORS   bool            `mapstructure:"enable_cors"`
	APIRoot      string          `mapstructure:"api_root"`
	StaticRoutes []StaticRoute   `mapstructure:"static_routes"`
}

func (*Config) NewEngine

func (g *Config) NewEngine() (*gin.Engine, gin.IRouter)

func (*Config) NewOpenAPI

func (g *Config) NewOpenAPI() *openapi.Openapi

func (*Config) NewServer

func (c *Config) NewServer() *Server

func (*Config) TryServeFiles

func (g *Config) TryServeFiles(sr StaticRoute) gin.HandlerFunc

TryServeFiles attempts to serve static files from the specified directory. If the requested file does not exist, it serves a custom "not found" page.

type ConfigSection

type ConfigSection string

const DefaultConfigSection ConfigSection = "gin-service"

type Handler

type Handler struct {
	Request  Request
	Response Response
	Handler  func(c *gin.Context)
}

type OpenAPIServer

type OpenAPIServer struct {
	// on production, this should be the actual url, e.g. https://api.example.com/api/v1
	Url         string `mapstructure:"url"`
	Description string `mapstructure:"description"`
}

type Request

type Request struct {
	Description string
	Query       any // from url query
	Json        any // from body
	Form        any // from body
	Xml         any // from body
}

type Response

type Response struct {
	Description string
	Json        any
	Xml         any
}

type Route

type Route struct {
	Method      string
	Path        string
	Summary     string
	Description string
	Security    Security
	Handler     Handler
}

func (Route) Use

func (r Route) Use(h Security) Route

type Security

type Security interface {
	Auth(c *gin.Context)
	SecurityScheme() []map[string][]string
}

type Server

type Server struct {
	API       *openapi.Openapi
	Port      int
	Engine    *gin.Engine
	APIRouter gin.IRouter
}

func GetServer

func GetServer(c *ioc.Container) *Server

func GetServerByConfig

func GetServerByConfig(configSection ConfigSection, c *ioc.Container) *Server

func (*Server) Register

func (s *Server) Register(services ...*Service)

func (*Server) Run

func (s *Server) Run(ctx context.Context)

func (*Server) SetSecuritySchemes

func (s *Server) SetSecuritySchemes(schemes openapi.SecuritySchemes)

type Service

type Service struct {
	Tag         string
	Description string
	Path        string
	Routes      []Route
}

type StaticRoute

type StaticRoute struct {
	Route    string `mapstructure:"route"`
	Dir      string `mapstructure:"dir"`
	NotFound string `mapstructure:"not_found"`
}