RuleApiPro 接口文档

生成时间:2026-09-03 12:06:17 来源:RuleApiPro/src/main/java/com/RuleApi/web/*.java 说明:本文档由脚本根据 Controller 源码自动生成,接口返回均为 JSON 字符串。

认证规则

  • 登录态 token 通过请求参数 token 传递。
  • 接口权限由注解 @LoginRequired(purview = "...") 声明,并由 LoginAspect 统一校验。
  • 校验失败时返回 code = 0,并附带相应 msg

权限等级表

purview 说明
-3 完全公开,不做任何校验
-2 公开接口,不校验 token
-1 公开接口;但当系统配置 isLogin=1 时会强制要求登录
0 需要登录(普通用户及以上)
1 需要管理员或编辑权限
2 需要超级管理员权限
其它 / 未标注 按代码逻辑说明

全局返回格式

Controller 层方法返回统一 JSON 字符串,格式如下:

{
  "code": 1,
  "msg": "操作成功",
  "data": { ... }
}
{
  "code": 0,
  "msg": "用户未登录或Token验证失败",
  "data": null
}

列表类接口通常还会附带 count(当前页数量)和 total(总数量)字段。

全局拦截说明(来自 LoginAspect)

  • banIP:若后台配置 banIP 并命中当前请求 IP,将返回 您的IP已被禁止请求,请联系管理员
  • ruleapiDBan / authorizeType:用于授权域名/URL 控制。authorizeType=1 时命中禁止列表则拦截;authorizeType=0 时未命中白名单则拦截。
  • 全局登录:当 isLogin=1 时,-1 权限接口会被当作 0(需要登录)处理。

模块索引