top.dingwen.io.api.doc
  1. 枚举
top.dingwen.io.api.doc
  • 公共模块
    • 枚举
      • 测试
        • 枚举序列化反序列化测试-请求参数
        • 枚举序列化反序列化测试-请求体参数
      • 获取所有枚举类型
        GET
      • 获取指定枚举类型
        GET
    • 文件
      • 上传文件
      • 下载单个文件
      • 多文件打包下载
      • 文件预览
      • 文件分页列表
      • 丢弃一个文件
      • 分页查询枚举类型
    • 本地缓存[caffeine]
      • 测试
        • 缓存get|set测试
      • 获取所有的缓存
      • 获取缓存详情
      • 获取缓存项详情
      • 清除缓存
      • 下载指定的缓存数据
    • Redis缓存
      • 测试
        • 轻松缓存
        • 限流
        • 防止重复提交
        • 分布式锁
        • 推送一个延迟任务
        • 消费延迟任务
        • 延迟删除
        • redisson全局限流
        • redissonIP限流
        • redisson集群限流
        • redisson业务key限流
        • 注解方式lock4j分布式锁组件
        • 模板方式lock4j分布式锁组件
        • redisson发布消息
        • redisson订阅消息
        • 添加一个优先任务队列
        • 删除优先任务
        • 获取优先任务
        • 添加一个有界任务队列
        • 删除有界任务
        • 获取有界队列的任务
        • 订阅延迟任务队列
        • 添加延迟任务
        • 删除延迟任务
        • 销毁延迟任务队列
        • 测试geo类型计算两点间距离
      • Redis信息
      • 获取所有缓存项
      • 获取指定前缀的所有key
      • 获取缓存值
      • 清除指定key前缀的所有缓存
      • 清除指定key的缓存
      • 清除所有缓存
    • 字典
      • 字典列表
      • 新增字典
      • 修改字典
      • 删除字典
      • 刷新字典
      • 新增字典值
      • 字典值列表
      • 修改字典值
      • 删除字典值
      • 字典值批量删除
      • 字典树列表
    • 日志
      • 测试
        • 方法日志
        • 操作日志
      • 方法执行日志列表
      • 请求日志列表
      • 清除所有方法日志
      • 清除所有请求日志
      • 请求日志详情
      • 方法执行日志详情
      • 操作日志列表
    • 配置
      • 刷新配置
      • 配置分页查询
      • 删除配置
      • 配置维护
    • Quartz任务
      • 所有执行中的job列表
      • 任务信息列表
      • 添加一个任务&job
      • 修改运行中的job信息
      • 修改任务&job状态
      • 删除任务&job
      • 立即执行
      • 任务执行日志
    • Excel
      • 系统配置导出Excel
      • 系统配置Excel导入
    • 事件
      • 事件列表
    • jwt
      • 测试
        • 生成App端JwtToken
        • 生成Web端JwtToken
        • 验证JwtToken
        • 判断是否需要刷新
        • 刷新JwtToken
    • 校验
      • 表单校验国际化消息测试
    • webplus
      • 测试
        • 国际化加校验测试
        • 调试日志
        • 测试高性能异步日志
        • 测试异常消息发送
        • 测试请求参数字符串去除空格
        • 测试请求体参数字符串去除空格
      • 优雅关机
      • webplus首页
      • 服务健康状态
      • 查看当前放行的端点
    • async
      • 测试
        • 定时任务线程池
      • 获取执行器消息
    • 进度条
      • 测试
        • 提交任务
      • 查询进展
    • 二级缓存
      • 测试
        • 二级获取获取业务id
    • 电子邮件
      • 测试
        • 发送邮件
    • 日志监控
      • 日志监控首页
    • 管道业务流[pipeline]
      • 测试
        • 测试业务线
  • 安全模块
    • 登录
      POST
    • 认证入口
      GET
    • 获取验证码
      GET
    • 退出登录
      GET
  1. 枚举

获取所有枚举类型

GET
/common/enums
1. 项目启动进行初始化,做本地缓存

请求参数

Authorization
在 Header 添加参数
Authorization
,其值为在 Bearer 之后拼接 Token
示例:
Authorization: Bearer ********************

返回响应

🟢200成功
application/json
Body
code
number 
返回code
可选
message
string 
消息
可选
data
object (枚举视图) 
数据
可选
name
string 
枚举名
可选
items
array[object (枚举项视图) {4}] 
枚举子项
可选
fullClassName
string 
枚举全类名
可选
currentTime
string <date-time>
服务器响应时间
可选
正则匹配:
yyyy-MM-dd HH:mm:ss
示例
{
  "code": 200,
  "message": "SUCCESS",
  "data": [
    {
      "name": "logicDelete",
      "items": [
        {
          "itemName": "DELETED",
          "code": 0,
          "desc": "删除"
        },
        {
          "itemName": "EXISTED",
          "code": 1,
          "desc": "存在"
        }
      ]
    },
    {
      "name": "orderMode",
      "items": [
        {
          "itemName": "DOWN",
          "code": "DESC",
          "desc": "降序"
        },
        {
          "itemName": "UP",
          "code": "ASC",
          "desc": "升序"
        }
      ]
    },
    {
      "name": "searchMode",
      "items": [
        {
          "itemName": "FULL",
          "code": "full",
          "desc": "包含模糊查询"
        },
        {
          "itemName": "eq",
          "code": "eq",
          "desc": "等于"
        },
        {
          "itemName": "left",
          "code": "left",
          "desc": "以什么结尾模糊查询"
        },
        {
          "itemName": "right",
          "code": "right",
          "desc": "以什么开头模糊查询"
        }
      ]
    },
    {
      "name": "fileBusinessType",
      "items": [
        {
          "itemName": "PERSONAL_PHOTO_ALBUM",
          "code": "personal_photo_album",
          "desc": "个人相册"
        }
      ]
    },
    {
      "name": "fileChannel",
      "items": [
        {
          "itemName": "MINIO",
          "code": "minio",
          "desc": "Minio对象存储"
        },
        {
          "itemName": "Ali_OSS",
          "code": "ali-oss",
          "desc": "阿里云对象存储"
        },
        {
          "itemName": "SYSTEM",
          "code": "system",
          "desc": "本地存储"
        }
      ]
    },
    {
      "name": "pipelineFilterExePoint",
      "items": [
        {
          "itemName": "ALL",
          "code": "all",
          "desc": "前后都执行"
        },
        {
          "itemName": "BEFORE",
          "code": "before",
          "desc": "仅前执行"
        },
        {
          "itemName": "AFTER",
          "code": "after",
          "desc": "仅后执行"
        }
      ]
    },
    {
      "name": "limitType",
      "items": [
        {
          "itemName": "DEFAULT",
          "code": "default",
          "desc": "默认策略全局限流"
        },
        {
          "itemName": "IP",
          "code": "ip",
          "desc": "根据请求者IP进行限流"
        }
      ]
    },
    {
      "name": "requestParam",
      "items": [
        {
          "itemName": "FORM",
          "code": "FORM",
          "desc": "表单"
        },
        {
          "itemName": "BODY",
          "code": "BODY",
          "desc": "请求体"
        },
        {
          "itemName": "HEADER",
          "code": "HEADER",
          "desc": "请求头"
        }
      ]
    },
    {
      "name": "barStatus",
      "items": [
        {
          "itemName": "INIT",
          "code": 0,
          "desc": "初始化"
        },
        {
          "itemName": "ING",
          "code": 1,
          "desc": "进行中"
        },
        {
          "itemName": "FAIL",
          "code": 2,
          "desc": "失败"
        },
        {
          "itemName": "SUCCESS",
          "code": 3,
          "desc": "成功"
        }
      ]
    },
    {
      "name": "barType",
      "items": [
        {
          "itemName": "TEST",
          "code": "test",
          "desc": "测试进度条类型"
        }
      ]
    },
    {
      "name": "poolPolicy",
      "items": [
        {
          "itemName": "ABORT_POLICY",
          "code": "AbortPolicy",
          "desc": "抛出一个类型为 RejectedExecutionException的RuntimeException"
        },
        {
          "itemName": "DISCARD_POLICY",
          "code": "DiscardPolicy",
          "desc": "丢弃"
        },
        {
          "itemName": "DISCARD_OLDEST_POLICY",
          "code": "DiscardOldestPolicy",
          "desc": "如果线程池没被关闭且没有能力执行,则会丢弃任务队列中的头结点"
        },
        {
          "itemName": "CALLER_RUNS_POLICY",
          "code": "CallerRunsPolicy",
          "desc": "当有新任务提交后,如果线程池没被关闭且没有能力执行,则把这个任务交于提交任务的线程执行,也就是谁提交任务,谁就负责执行任务"
        }
      ]
    },
    {
      "name": "dicDataDefault",
      "items": [
        {
          "itemName": "YES",
          "code": "Y",
          "desc": "是"
        },
        {
          "itemName": "NO",
          "code": "N",
          "desc": "否"
        }
      ]
    },
    {
      "name": "dicStatus",
      "items": [
        {
          "itemName": "ENABLED",
          "code": "1",
          "desc": "启用"
        },
        {
          "itemName": "DISABLED",
          "code": "0",
          "desc": "禁用"
        }
      ]
    }
  ],
  "currentTime": "2023-06-09 15:14:53"
}
修改于 2024-01-31 05:54:13
上一页
枚举序列化反序列化测试-请求体参数
下一页
获取指定枚举类型
Built with