http_module

Documentation

Index

• Variables
• func CheckConfig(cfg Config) error
• func Module(force bool) fx.Option
• func NewEcho(logger *zap.Logger, lc fx.Lifecycle, cfg Config, ...) *echo.Echo
• type Config
  • func ReadConfig(v *viper.Viper) (Config, error)
• type CorsSetting
• type HttpOptions
  • func BeforeHttp() HttpOptions

Variables

var DefaultConfig = wrappedCfg{
	Http: Config{
		ListenAddr:    "0.0.0.0",
		ListenPort:    3000,
		LogAllRequest: true,
		CORS: CorsSetting{
			AllowOrigins: []string{"*"},
			AllowHeaders: []string{"Accept", "Content-Type", "Content-Length", "Accept-Encoding", "Authorization", "ResponseType"},
		},
		H2c: false,
	},
}

Functions

func CheckConfig

func CheckConfig(cfg Config) error

func Module

func Module(force bool) fx.Option

func NewEcho

func NewEcho(
	logger *zap.Logger,
	lc fx.Lifecycle,
	cfg Config,
	serviceParams svc_module.OptionalConfig,
	ocfg optionalParams,
) *echo.Echo

Types

type Config

type Config struct {
	ListenAddr     string      `mapstructure:"listen-addr" validate:"required,ip"`
	ListenPort     int         `mapstructure:"listen-port" validate:"required,gt=0,lte=65535"`
	LogAllRequest  bool        `mapstructure:"log-all-request"`
	LogIgnorePaths []string    `mapstructure:"log-ignore-paths"`
	CORS           CorsSetting `mapstructure:"cors"`
	H2c            bool        `mapstructure:"h2c"`
}

func ReadConfig

func ReadConfig(v *viper.Viper) (Config, error)

type CorsSetting

type CorsSetting struct {
	AllowOrigins []string `mapstructure:"allowed-origins"`
	AllowHeaders []string `mapstructure:"allowed-header"`
}

type HttpOptions

type HttpOptions struct {
	fx.Out

	Before []beforeHttp `group:"before_http,flatten"`
}

func BeforeHttp

func BeforeHttp() HttpOptions