完成首次安装并可创建 Root 用户

POST

/api/setup

初始化系统

🔓 无需鉴权

本地契约说明

路由：POST /api/setup

注册处理器：github.com/QuantumNous/new-api/controller.PostSetup。

消费方：web_vue。

鉴权：匿名。无需 Dashboard 登录；仍可能有频率限制、功能开关或导航模块限制。

字段状态：controller-confirmed-setup-sensitive。字段为动态上游数据或回调负载时，文档会明确标记，不能补造 Schema。

页面/功能：首次安装表单创建初始 Root（仅尚无 Root 用户时），并保存自用/演示模式。

前端传参：SelfUseModeEnabled、DemoSiteEnabled；当 GET /setup 显示 root_init=false 时还需 username、password、confirmPassword。密码只在当前请求中使用。

前端展示：success/message；完成后重新读取 GET /api/setup，不会返回登录 token、用户资料或密码。

调试：使用本操作的 x-debug 里的占位符；示例不含真实密码、API Key、签名、Cookie 或 Provider 密钥。

请求参数

Body 参数application/json必填

示例

{
    "username": "root",
    "password": "<redacted-root-password>",
    "confirmPassword": "<redacted-root-password>",
    "SelfUseModeEnabled": false,
    "DemoSiteEnabled": false
}

请求示例代码

Shell

JavaScript

Java

Swift

PHP

Python

HTTP

Objective-C

Ruby

OCaml

Dart

curl --location 'http://api-dev.opensosen.cn/api/setup' \
--header 'Content-Type: application/json' \
--data '{
    "username": "root",
    "password": "<redacted-root-password>",
    "confirmPassword": "<redacted-root-password>",
    "SelfUseModeEnabled": false,
    "DemoSiteEnabled": false
}'

返回响应

🟢200

application/json

公开 API 成功或业务失败响应。HTTP 200 时仍需检查 success。

Bodyapplication/json

示例

{
    "success": true,
    "message": "系统初始化成功"
}

修改于 2026-08-14 17:19:51

读取首次安装状态

读取用户协议正文

完成首次安装并可创建 Root 用户

本地契约说明#

请求参数

请求示例代码

返回响应

本地契约说明