mirror of
https://github.com/bestnite/sub2clash.git
synced 2025-06-17 12:43:18 +08:00
update
This commit is contained in:
33
README.md
33
README.md
@ -19,26 +19,29 @@
|
||||
|
||||
## API
|
||||
|
||||
### /clash
|
||||
### `/clash`,`/meta`
|
||||
|
||||
获取 Clash 配置链接
|
||||
获取 Clash/Clash.Meta 配置链接
|
||||
|
||||
| Query 参数 | 类型 | 说明 |
|
||||
|----------|--------|-------------------------|
|
||||
| sub | string | 订阅链接(可以输入多个订阅,用 `,` 分隔) |
|
||||
| refresh | bool | 强制刷新配置(默认缓存 5 分钟) |
|
||||
| Query 参数 | 类型 | 是否必须 | 说明 |
|
||||
|--------------|--------|-------------------|--------------------------------------------------------------------------------------------------------------------------------------------------------------------|
|
||||
| sub | string | sub/proxy 至少有一项存在 | 订阅链接(可以输入多个,用 `,` 分隔) |
|
||||
| proxy | string | sub/proxy 至少有一项存在 | 节点分享链接(可以输入多个,用 `,` 分隔) |
|
||||
| refresh | bool | 否(默认 `false`) | 强制刷新配置(默认缓存 5 分钟) |
|
||||
| template | string | 否 | 外部模板 |
|
||||
| ruleProvider | string | 否 | 格式 `[Behavior,Url,Group,Prepend],[Behavior,Url,Group,Prepend],...`,其中 `Group` 是该规则集所走的策略组名,`Prepend` 为 bool 类型,如果为 `true` 规则将被添加到规则列表顶部,否则添加到规则列表底部(会调整到MATCH规则之前) |
|
||||
| rule | string | 否 | 格式 `[Rule,Prepend],[Rule,Prepend]...`,其中 `Prepend` 为 bool 类型,如果为 `true` 规则将被添加到规则列表顶部,否则添加到规则列表底部(会调整到MATCH规则之前) |
|
||||
| autoTest | bool | 否(默认 `false`) | 指定国家策略组是否自动测速 |
|
||||
| lazy | bool | 否(默认 `false`) | 自动测速是否启用 lazy |
|
||||
|
||||
### /meta
|
||||
## 默认模板
|
||||
|
||||
获取 Meta 配置链接
|
||||
- [Clash](./templates/template_clash.yaml)
|
||||
- [Clash.Meta](./templates/template_meta.yaml)
|
||||
|
||||
| Query 参数 | 类型 | 说明 |
|
||||
|----------|--------|-------------------------|
|
||||
| sub | string | 订阅链接(可以输入多个订阅,用 `,` 分隔) |
|
||||
| refresh | bool | 强制刷新配置(默认缓存 5 分钟) |
|
||||
## 已知问题
|
||||
|
||||
[代理链接解析](./parser)还没有经过严格测试,可能会出现解析错误的情况,如果出现问题请提交 issue
|
||||
|
||||
## TODO
|
||||
|
||||
- [ ] 完善日志功能
|
||||
- [ ] 支持自动测速分组
|
||||
- [ ] 完善配置模板
|
||||
|
Reference in New Issue
Block a user