config

type Certificate struct {
	Cert string `yaml:"cert,omitempty" json:"cert,omitempty" xml:"cert,omitempty"`
	Key  string `yaml:"key,omitempty" json:"key,omitempty" xml:"key,omitempty"`
}

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

type Duration time.Duration

type ErrorHandler struct {
	Status  []int
	Handler ErrorHandlerFunc
}

type ErrorHandlerFunc = errorhandler.HandleFunc

type FieldError struct {
	Field, Message string
}

type HTTP struct {
	// 网站的域名证书
	//
	// 该设置并不总是生效的，具体的说明可参考 TLSConfig 字段的说明。
	Certificates []*Certificate `yaml:"certificates,omitempty" json:"certificates,omitempty" xml:"certificates,omitempty"`

	// 应用于 http.Server 的几个变量
	ReadTimeout       Duration `yaml:"readTimeout,omitempty" json:"readTimeout,omitempty" xml:"readTimeout,attr,omitempty"`
	WriteTimeout      Duration `yaml:"writeTimeout,omitempty" json:"writeTimeout,omitempty" xml:"writeTimeout,attr,omitempty"`
	IdleTimeout       Duration `yaml:"idleTimeout,omitempty" json:"idleTimeout,omitempty" xml:"idleTimeout,attr,omitempty"`
	ReadHeaderTimeout Duration `yaml:"readHeaderTimeout,omitempty" json:"readHeaderTimeout,omitempty" xml:"readHeaderTimeout,attr,omitempty"`
	MaxHeaderBytes    int      `yaml:"maxHeaderBytes,omitempty" json:"maxHeaderBytes,omitempty" xml:"maxHeaderBytes,attr,omitempty"`

	// 指定 https 模式下的证书配置项
	//
	// 如果用户指定了 Certificates 字段，则会根据此字段生成，
	// 用户也可以自已覆盖此值，比如采用 golang.org/x/crypto/acme/autocert.Manager.TLSConfig
	// 配置 Let's Encrypt。
	TLSConfig *tls.Config `yaml:"-" json:"-" xml:"-"`
}

type Locale struct {
	Key message.Reference
	// contains filtered or unexported fields
}

type Middleware = middleware.Middleware

type Router struct {
	// 是否禁用自动生成 OPTIONS 和 HEAD 请求的处理
	DisableOptions bool `yaml:"disableOptions,omitempty" json:"disableOptions,omitempty" xml:"disableOptions,attr,omitempty"`
	DisableHead    bool `yaml:"disableHead,omitempty" json:"disableHead,omitempty" xml:"disableHead,attr,omitempty"`
	SkipCleanPath  bool `yaml:"skipCleanPath,omitempty" json:"skipCleanPath,omitempty" xml:"skipCleanPath,attr,omitempty"`

	// 调试相关的路由设置项
	Pprof string `yaml:"pprof,omitempty" json:"pprof,omitempty" xml:"pprof,omitempty"`
	Vars  string `yaml:"vars,omitempty" json:"vars,omitempty" xml:"vars,omitempty"`
}

type UnmarshalFunc func(config string, v interface{}) error

type Web struct {
	XMLName struct{} `yaml:"-" json:"-" xml:"web"`

	// 网站的根目录所在
	//
	// 比如 https://example.com/api/
	Root string `yaml:"root,omitempty" json:"root,omitempty" xml:"root,omitempty"`

	// 与路由设置相关的配置项
	Router *Router `yaml:"router,omitempty" json:"router,omitempty" xml:"router,omitempty"`

	// 与 HTTP 请求相关的设置项
	HTTP *HTTP `yaml:"http,omitempty" json:"http,omitempty" xml:"http,omitempty"`

	// 指定插件的搜索方式
	//
	// 通过 glob 语法搜索插件，比如：
	//  ~/plugins/*.so
	// 具体可参考：https://golang.org/pkg/path/filepath/#Glob
	// 为空表示没有插件。
	//
	// 当前仅支持部分系统，具体可查看：https://golang.org/pkg/plugin/
	Plugins string `yaml:"plugins,omitempty" json:"plugins,omitempty" xml:"plugins,omitempty"`

	// 指定关闭服务时的超时时间
	//
	// 如果此值不为 0，则在关闭服务时会调用 http.Server.Shutdown 函数等待关闭服务，
	// 否则直接采用 http.Server.Close 立即关闭服务。
	ShutdownTimeout Duration `yaml:"shutdownTimeout,omitempty" json:"shutdownTimeout,omitempty" xml:"shutdownTimeout,omitempty"`

	// 时区名称
	//
	// 可以是 Asia/Shanghai 等，具体可参考：
	// https://en.wikipedia.org/wiki/List_of_tz_database_time_zones
	//
	// 为空和 Local(注意大小写) 值都会被初始化本地时间。
	Timezone string `yaml:"timezone,omitempty" json:"timezone,omitempty" xml:"timezone,omitempty"`

	// Cache 指定缓存对象
	//
	// 可看查看 github.com/issue9/cache 中相关的实现，
	// 用户也可以自己实现 github.com/issue9/cache.Cache 接口。
	//
	// 如果用户未指定，则会采用以下方式提供默认值：
	//  github.com/issue9/cache/memory.New(24 * time.Hour)
	Cache cache.Cache `yaml:"-" json:"-" xml:"-"`

	// 本地化消息的管理组件
	//
	// 为空的情况下会引用 golang.org/x/text/message.DefaultCatalog 对象。
	//
	// golang.org/x/text/message/catalog 提供了 NewBuilder 和 NewFromMap
	// 等方式构建 Catalog 接口实例。
	Catalog catalog.Catalog `yaml:"-" json:"-" xml:"-"`

	// 指定中间件
	//
	// Middlewares 和 Filters 都表示中间件，两者的功能没有本质上的差别。
	// 之所以提供了两个类型，是因为 Middlewares 兼容 http.Handler 类型，
	// 可以对市面上大部分的中间件稍加改造即可使用，而 Filter
	// 则提供了部分 http.Handler 不存在的数据字段，且两者不能交替出现，
	// 干脆同时提供两种中间件。
	//
	// 在使用上，永远是 Middlewares 在 Filters 之前调用。
	Middlewares []Middleware `yaml:"-" json:"-" xml:"-"`
	Filters     []web.Filter `yaml:"-" json:"-" xml:"-"`

	// 指定各类媒体类型的编解码函数
	Marshalers   map[string]content.MarshalFunc   `yaml:"-" json:"-" xml:"-"`
	Unmarshalers map[string]content.UnmarshalFunc `yaml:"-" json:"-" xml:"-"`

	// 指定生成 Result 的方法
	//
	// 可以为空，表示采用 CTXServer 的默认值。
	ResultBuilder result.BuildFunc `yaml:"-" json:"-" xml:"-"`

	// 返回给用户的错误提示信息
	//
	// 对键名作了一定的要求：要求最高的三位数必须是一个 HTTP 状态码，
	// 比如 40001，在返回给客户端时，会将 400 作为状态码展示给用户，
	// 同时又会将 40001 和对应的消息发送给用户。
	//
	// 该数据最终由 web.Server.AddMessage 添加。
	Results map[int]Locale `yaml:"-" json:"-" xml:"-"`

	// 指定错误页面的处理方式
	ErrorHandlers []*ErrorHandler `yaml:"-" json:"-" xml:"-"`

	// 指定用于触发关闭服务的信号
	//
	// 如果为 nil，表示未指定任何信息，如果是长度为 0 的数组，则表示任意信号，
	// 如果指定了多个相同的值，则该信号有可能多次触发。
	ShutdownSignal []os.Signal `yaml:"-" json:"-" xml:"-"`
	// contains filtered or unexported fields
}