You cannot select more than 25 topics
Topics must start with a letter or number, can include dashes ('-') and can be up to 35 characters long.
46 lines
1.0 KiB
Markdown
46 lines
1.0 KiB
Markdown
3 years ago
|
## How to use
|
||
|
|
|
||
|
|
1. Define a config structure, like below:
|
||
|
|
|
||
|
|
```go
|
||
|
|
RestfulConf struct {
|
||
|
|
Host string `json:",default=0.0.0.0"`
|
||
|
|
Port int
|
||
|
|
LogMode string `json:",options=[file,console]"
|
||
|
|
Verbose bool `json:",optional"`
|
||
|
|
MaxConns int `json:",default=10000"`
|
||
|
|
MaxBytes int64 `json:",default=1048576"`
|
||
|
|
Timeout time.Duration `json:",default=3s"`
|
||
|
|
CpuThreshold int64 `json:",default=900,range=[0:1000]"`
|
||
|
|
}
|
||
|
|
```
|
||
|
|
|
||
|
|
2. Write the yaml or json config file:
|
||
|
|
|
||
|
|
```yaml
|
||
|
|
# most fields are optional or have default values
|
||
|
|
Port: 8080
|
||
|
|
LogMode: console
|
||
|
|
# you can use env settings
|
||
|
|
MaxBytes: ${MAX_BYTES}
|
||
|
|
```
|
||
|
|
|
||
|
|
3. Load the config from a file:
|
||
|
|
|
||
|
|
```go
|
||
|
|
// exit on error
|
||
|
|
var config RestfulConf
|
||
|
|
conf.MustLoad(configFile, &config)
|
||
|
|
|
||
|
|
// or handle the error on your own
|
||
|
|
var config RestfulConf
|
||
|
|
if err := conf.Load(configFile, &config); err != nil {
|
||
|
|
log.Fatal(err)
|
||
|
|
}
|
||
|
|
|
||
|
|
// enable reading from environments
|
||
|
|
var config RestfulConf
|
||
|
|
conf.MustLoad(configFile, &config, conf.UseEnv())
|
||
|
|
```
|
||
|
|
|