config

Documentation

Index

• Constants
• func GetConfig() *reborn.Reborn
• func SetupConfig(rdb *redis.Client) error
• func UpdateIdConfig(c *IdConfig)
• func UpdateLandingHosts(hosts []string)
• func UpdateShortLinkNotFoundConfig(s *ShortLinkNotFoundConfig)
• type IdConfig
  • func GetIdConfig() *IdConfig
• type ShortLinkNotFoundConfig
  • func GetShortLinkNotFoundConfig() *ShortLinkNotFoundConfig
  • func (s *ShortLinkNotFoundConfig) ToMap() map[string]string
• type SystemConfig
  • func GetSystemConfig() *SystemConfig

Constants

const (
	ShortLinkNotFoundContentMode  = "content"
	ShortLinkNotFoundRedirectMode = "redirect"
	DefaultIdLength               = 6
	DefaultIdMinimumLength        = 2
	DefaultIdMaximumLength        = 10
)

Functions

func GetConfig

func GetConfig() *reborn.Reborn

func SetupConfig

func SetupConfig(rdb *redis.Client) error

func UpdateIdConfig

func UpdateIdConfig(c *IdConfig)

func UpdateLandingHosts

func UpdateLandingHosts(hosts []string)

func UpdateShortLinkNotFoundConfig

func UpdateShortLinkNotFoundConfig(s *ShortLinkNotFoundConfig)

Types

type IdConfig

type IdConfig struct {
	// ID 长度
	IdLength int `json:"idLength" format:"int" example:"6"`

	// 最小 ID 长度
	IdMinimumLength int `json:"idMinimumLength" format:"int" example:"2"`

	// 最大 ID 长度
	IdMaximumLength int `json:"idMaximumLength" format:"int" example:"10"`

} // @name IdConfig

func GetIdConfig

func GetIdConfig() *IdConfig

type ShortLinkNotFoundConfig

type ShortLinkNotFoundConfig struct {
	// 模式
	Mode string `json:"mode" binding:"required" example:"content" enums:"content,redirect"`

	// 值
	Value string `json:"value" binding:"required" example:"page not found"`

} // @name ShortLinkNotFoundConfig

func GetShortLinkNotFoundConfig

func GetShortLinkNotFoundConfig() *ShortLinkNotFoundConfig

func (*ShortLinkNotFoundConfig) ToMap

func (s *ShortLinkNotFoundConfig) ToMap() map[string]string

type SystemConfig

type SystemConfig struct {
	// 落地页 Host 列表
	LandingHosts []string `json:"landingHosts" format:"array" example:"https://a.com/,https://b.com/"`

	// ID 配置
	IdConfig *IdConfig `json:"idConfig"`

	// 短链接 404 配置
	ShortLinkNotFoundConfig *ShortLinkNotFoundConfig `json:"shortLinkNotFoundConfig"`

} // @name SystemConfig

func GetSystemConfig

func GetSystemConfig() *SystemConfig