Getting Started

快速开始

本页用于完成第一次转换，并判断问题位于请求、后端还是客户端。

1. 选择使用方式

方式	适合场景	需要注意
公共实例 https://api.asailor.org	临时体验、OpenClash 等已内置后端的场景	请求可能携带订阅 URL；不适合把公共后端当作秘密存储
自行部署	长期使用、需要自定义安全和出站策略、订阅较敏感	需要负责 TLS、端口、备份、更新和访问控制

自行部署优先选择 Docker 部署。无法运行容器时，查看原生部署。

2. 确认服务身份

访问版本页：

https://api.asailor.org/version

自行部署时：

http://localhost:25500/version

预期结果：页面显示 SubConverter-Extended、版本号和源代码修订。若页面无法访问，先处理部署或网络问题，不要继续构造转换请求。

3. 选择目标格式

常见选择：

客户端	建议起点
OpenClash 或其他 Mihomo 客户端	target=clash
Surge	target=surge&ver=实际主版本
Quantumult X	target=quanx
Loon	target=loon
Surfboard	target=surfboard
Stash	target=stash
Sing-box	target=singbox

完整列表和解析路径见客户端与目标格式。不确定时显式填写 target，不要依赖 target=auto 猜测。

4. 构造第一次请求

以下示例使用占位订阅：

https://api.asailor.org/sub?target=clash&url=https%3A%2F%2Fexample.com%2Fsub

其中：

• target=clash 表示生成 Clash/Mihomo 配置；
• url= 后是完成 URL 编码的订阅地址；
• 多个输入使用 | 分隔后，再对完整 url 值编码。

不要把真实订阅地址粘贴到 Issue、聊天记录、截图或公开日志中。

5. 检查结果

请求成功时应返回目标配置，而不是版本页、HTML 错误页或空内容。

target=clash 的远程 HTTP 订阅通常生成：

proxy-providers:
  Provider_XXXXXX:
    type: http
    url: https://example.com/sub

直接节点链接或 list=true 会进入不同路径，不能用是否存在 proxy-providers 作为所有请求的统一成功标准。

6. 在客户端验证

1. 将生成链接添加到客户端。
2. 触发一次配置更新。
3. 检查客户端是否成功加载配置。
4. 检查远程 Provider 或节点是否存在。
5. 检查 DNS 和实际连通性。

Important

除 Stash 独立模板外，默认输出通常不包含完整 DNS 设置。OpenClash 可启用 DNS 覆写；其他客户端需要使用合适的基础模板或自行补充 DNS。

7. 请求失败时

在原请求中增加：

&explain=true

或打开：

https://api.asailor.org/inspect

诊断模式返回脱敏报告，不返回最终配置。需要向维护者提供信息时，优先提供：

• HTTP 状态码；
• X-Request-ID；
• 诊断报告中不含秘密的部分；
• 目标格式和可公开复现的最小输入。

详细步骤见请求诊断和故障排查。

下一步：基本转换 · 特色参数与扩展语法