server

Documentation

Index

• func NewHuma(params HumaParams) huma.API
• func NewMux(params MuxParams) *chi.Mux
• type Addr
  • func ListenAddress(addr string) Addr
  • func ListenAddressFromEnv(env string, defaultValue ...string) Addr
• type CorsConfig
  • func WithCors(config CorsConfig) *CorsConfig
• type HumaParams
• type MuxParams
• type Params
• type Router
  • func NewRouter(cfg RouterConfig) *Router
• type RouterConfig
• type Server
  • func New(params Params) *Server
  • func (s *Server) OnStart(ctx context.Context) error
  • func (s *Server) OnStop(ctx context.Context) error
• type UseCors

Functions

func NewHuma

func NewHuma(params HumaParams) huma.API

func NewMux

func NewMux(params MuxParams) *chi.Mux

Types

type Addr

type Addr string

func ListenAddress

func ListenAddress(addr string) Addr

func ListenAddressFromEnv

func ListenAddressFromEnv(env string, defaultValue ...string) Addr

type CorsConfig

type CorsConfig struct {
	AllowedOrigins   []string
	AllowedMethods   []string
	AllowedHeaders   []string
	ExposedHeaders   []string
	AllowCredentials bool
	MaxAge           int
}

func WithCors

func WithCors(config CorsConfig) *CorsConfig

type HumaParams

type HumaParams struct {
	fx.In
	Manifest      *manifest.Manifest
	Mux           *chi.Mux
	AuthProviders *auth.Providers `optional:"true"`
}

type MuxParams

type MuxParams struct {
	fx.In
	UseCors UseCors     `optional:"true"`
	Cors    *CorsConfig `optional:"true"`
}

type Params

type Params struct {
	fx.In
	Addr      Addr `optional:"true"`
	Router    *Router
	ApiConfig *api.Config    `optional:"true"`
	Handlers  []*api.Handler `group:"api.handler"`
}

type Router

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

func NewRouter

func NewRouter(cfg RouterConfig) *Router

type RouterConfig

type RouterConfig struct {
	fx.In
	Mux            *chi.Mux
	Api            huma.API
	AuthMiddleware *auth.Middleware
}

type Server

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

func New

func New(params Params) *Server

func (*Server) OnStart

func (s *Server) OnStart(ctx context.Context) error

func (*Server) OnStop

func (s *Server) OnStop(ctx context.Context) error

type UseCors

type UseCors bool

UseCors define if the server should use CORS Deprecated: use CorsConfig instead