Files
full/module/base/mgt/doc/pub.md

3.1 KiB
Raw Blame History

公开接口文档(免鉴权)

基础路径:/mgt/,以下接口不需要 JWT 认证。


1. 登录

路径POST /mgt/login

说明:支持账号密码登录或 AppId/AppKey 登录,二选一。

请求体LoginRequest

参数 类型 必填 说明
account string 账号(与 password 一起使用)
password string 密码
phone string 手机号,若使用需符合 phone 格式
phone_code string 手机验证码
workspace string 应用 workspace
app_id string 应用 ID与 app_key 一起使用)
app_key string 应用密钥

约束account + passwordapp_id + app_key 必须提供一组。

请求示例(账号密码)

{
  "account": "zhangsan",
  "password": "abc12345",
  "workspace": "my_app"
}

请求示例(应用密钥)

{
  "app_id": "my_app",
  "app_key": "secret_key_xxx"
}

返回LoginResp

参数 类型 说明
token string JWT后续请求放在 Header Authorization
user_id number 用户 ID
identity string 用户唯一标识
account string 账号
name string 姓名
phone string 手机号
email string 邮箱
avatar string 头像

返回示例

{
  "code": 0,
  "data": {
    "token": "eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9...",
    "user_id": 1,
    "identity": "01ARZ3NDEKTSV4RRFFQ69G5FAV",
    "account": "zhangsan",
    "name": "张三",
    "phone": "13800138000",
    "email": "zhangsan@example.com",
    "avatar": "https://example.com/avatar.png"
  }
}

2. 刷新 Token

路径POST /mgt/refresh

说明:基于当前请求中的 JWT 签发新 token。通常需在 Header 中带有效 Authorization。

请求体:无,或空 JSON {}

返回

参数 类型 说明
token string 新的 JWT

返回示例

{
  "code": 0,
  "data": {
    "token": "eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9..."
  }
}

3. 重置密码(短信验证码)

路径POST /mgt/reset

请求体ForgetPwdRequest

参数 类型 必填 说明
account string 账号
code string 短信验证码
password string 新密码,最少 6 位
phone string 手机号,需符合 phone 格式

请求示例

{
  "account": "zhangsan",
  "code": "123456",
  "password": "newpass123",
  "phone": "13800138000"
}

返回示例

{
  "code": 0,
  "data": "密码重置成功"
}

4. 健康检查 Ping

路径GET /mgt/ping

说明:无需请求体,用于健康检查。

返回示例

{
  "message": "Pong"
}

5. Session 演示

路径GET /mgt/session

说明Session 示例接口,会写入并读取 session。

返回示例

{
  "message": "Pong"
}