Skip to content

API Routes

All API routes are mounted under /api/v1/.

Authentication (/auth)

MethodPathDescription
POST/auth/loginAuthenticate user, return access + refresh tokens
POST/auth/refresh-tokenRefresh access token using refresh token
GET/auth/getUserInfoGet current user info with roles and buttons

Login Request

json
POST /api/v1/auth/login
{
  "userName": "admin",
  "password": "admin123"
}

Login Response

json
{
  "code": "0000",
  "msg": "OK",
  "data": {
    "token": "eyJhbGciOiJIUzI1NiIs...",
    "refreshToken": "eyJhbGciOiJIUzI1NiIs..."
  }
}

System Management (/system-manage)

Users

MethodPathDescription
POST/system-manage/users/all/Search users (paginated, with filters)
GET/system-manage/users/{user_id}Get single user
POST/system-manage/usersCreate user
PATCH/system-manage/users/{user_id}Update user
DELETE/system-manage/users/{user_id}Delete user
DELETE/system-manage/usersBatch delete (ids array)

Roles

MethodPathDescription
GET/system-manage/rolesGet all enabled roles
POST/system-manage/roles/all/Search roles (paginated)
GET/system-manage/roles/{role_id}Get single role
POST/system-manage/rolesCreate role
PATCH/system-manage/roles/{role_id}Update role + permissions
DELETE/system-manage/roles/{role_id}Delete role
MethodPathDescription
GET/system-manage/menusGet menu tree
POST/system-manage/menusCreate menu
PATCH/system-manage/menus/{menu_id}Update menu
DELETE/system-manage/menus/{menu_id}Delete menu
GET/system-manage/menus/pages/Get all pages (for component selection)

Dynamic Routes (/route)

MethodPathDescription
GET/route/routesGet accessible routes for current user (RBAC filtered)

Route Response

json
{
  "code": "0000",
  "data": {
    "home": "home",
    "routes": [
      {
        "name": "manage",
        "path": "/manage",
        "component": "layout.base",
        "meta": {
          "title": "manage",
          "i18nKey": "route.manage",
          "icon": "carbon:cloud-service-management",
          "order": 9
        },
        "children": [...]
      }
    ]
  }
}

Pagination Format

Paginated endpoints return:

json
{
  "code": "0000",
  "msg": "OK",
  "data": [
    { "id": 1, "userName": "admin", ... }
  ],
  "total": 100,
  "current": 1,
  "size": 10
}

Authentication Header

All authenticated endpoints require:

Authorization: Bearer <access_token>

基于 MIT 协议发布