接口约定

后端只输出 JSON，页面渲染完全交给前端单页应用。

响应信封

除文件下载等流式接口外，统一使用：

{
  "code": 0,
  "data": {},
  "message": ""
}

字段	说明
code	0 表示成功；非 0 为业务错误码
data	业务数据（可能是对象、数组或 null）
message	提示信息，失败时为原因描述

部分早期接口使用小写信封（如验证码接口统一为小写响应），以接口实际返回为准。

在线文档

运行中的面板自带 Swagger UI：

http://<host>:12395/swagger/index.html

仓库内的接口描述文件：docs/swagger.yaml / docs/swagger.json。

关键接口

接口	说明
GET /api/auth/entry	启动入口状态：是否已安装、安全入口是否启用、数据库是否可用
GET /manager/system/environment	宿主机运行环境
GET /manager/system/metrics	实时性能指标
GET /manager/system/overview	环境 + 指标（仪表盘使用）
GET /manager/system/ports	监听端口列表，支持 protocol（tcp/tcp6/udp/udp6/all）与 keyword
GET/POST /manager/cors	跨域配置读写

有状态请求

• 认证基于会话 Cookie（NGINGSID，框架既定约定）
• 登录密码使用 SM2 加密后提交，环境密钥与 UA 绑定并持久化
• 部分管理接口需要相应角色权限，未授权返回业务错误码

相关

• 技术栈
• 开发指引