ujcms
  1. 环境接口
ujcms
  • 数据
    • 栏目列表_ChannelList
      GET
    • 栏目对象_Channel
      GET
    • 栏目对象ByAlias_Channel
      GET
    • 文章列表_ArticleList
      GET
    • 文章分页_ArticlePage
      GET
    • 文章对象_Article
      GET
    • 上一篇文章_ArticlePrev
      GET
    • 下一篇文章_ArticleNext
      GET
    • 全文检索文章分页_EsArticlePage
      GET
    • 全文检索文章列表_EsArticleList
      GET
    • 区块项列表_BlockItemList
      GET
    • 字典列表_DictList
      GET
    • 模型列表_ModelList
      GET
    • 模型对象_Model
      GET
    • Tag列表_TagList
      GET
    • Tag分页_TagPage
      GET
    • 获取Tag对象
      GET
    • 表单列表_FormList
      GET
    • 表单分页_FormPage
      GET
    • 获取表单对象
      GET
    • 站点列表_SiteList
      GET
    • 站点对象_Site
      GET
    • 投票列表_VoteList
      GET
    • 投票分页_VotePage
      GET
    • 投票对象_Vote
      GET
    • 留言列表_MessageBoardList
      GET
    • 留言分页_MessageBoardPage
      GET
    • 获取留言对象
      GET
    • 留言类型列表_MessageBoardTypeList
      GET
    • 调查问卷列表_SurveyList
      GET
    • 调查问卷分页_SurveyPage
      GET
    • 调查问卷对象_Survey
      GET
    • 文章排行榜列表_LeaderBoardList
      GET
    • 文章排行榜分页_LeaderBoardPage
      GET
  • 内容
    • 栏目接口
      • 获取栏目浏览次数
      • 获取栏目统计数据
    • 文章接口
      • 顶文章
      • 记录下载次数
      • 踩文章
      • 获取文章浏览次数
      • 获取下载参数
      • 获取文章统计数据
    • 站点接口
      • 获取站点缓冲对象,并记录浏览量
      • 获取当前站点对象。如果传递subDir参数,则通过子目录查询当前站点;否则通过当前域名获取对应站点对象,无法获取则返回默认站点
      • 获取站点缓冲对象
    • 投票接口
      • 投票
    • 留言接口
      • 提交留言
    • 调查问卷接口
      • 投票
  • 用户
    • JWT认证接口
      • 刷新TOKEN
      • 退出。一般情况下JWT无需服务器端退出。该方法主要用于记录退出日志
      • 登录
    • 注册接口
      • 用户注册
    • 密码接口
      • 更新密码
      • 重置密码
    • 会员设置接口
      • 更新个人信息
      • 更新手机号码
      • 更新邮箱地址
      • 更新个人头像
    • 用户接口
      • 用户名是否未使用
      • 用户名是否存在
      • 手机号码是否未使用
      • 手机号码是否存在
      • 邮箱地址是否未使用
      • 邮箱地址是否存在
    • 上传接口
      • avatarUpload
      • avatarCrop
  • 系统
    • 环境接口
      • 是否开启双因子登录
        GET
      • 获得当前登录用户
        GET
      • 获取当前站点列表
        GET
      • csrf 参数
        GET
      • 获取Config配置
        GET
      • 获取客户端SM2加密 public key
        GET
    • 验证码接口
      • 尝试验证码是否正确
      • 是否显示验证码。当登录错误超过指定次数后,需要输入验证码
      • 获取验证码Token
    • 短信接口
      • 发送手机短信
      • 发送邮件短信
      • 验证手机短信是否正确
      • 验证邮件短信是否正确
  • 其它
    • 访问统计接口
      • 记录访问统计接口
      • 获取在线访问者数量
  1. 环境接口

获取Config配置

GET
/api/env/config
环境接口
获取Config配置

请求参数

无

示例代码

Shell
JavaScript
Java
Swift
Go
PHP
Python
HTTP
C
C#
Objective-C
Ruby
OCaml
Dart
R
请求示例请求示例
Shell
JavaScript
Java
Swift
curl --location --request GET 'https://demo.ujcms.com/api/env/config'

返回响应

🟢200成功
*/*
OK
Body
全局配置实体类
id
integer <int64>
ID
必需
contextPath
string 
上下文路径
可选
port
integer <int32>
端口号
可选
multiDomain
boolean 
必需
是否多域名(多域名在生成静态页时,需要按域名分开存放)
channelUrl
string 
栏目URL地址
可选
正则匹配:
^$|^/[\w-]*$
articleUrl
string 
文章URL地址
可选
正则匹配:
^$|^/[\w-]*$
defaultSiteId
integer <int64>
默认站点ID
必需
upload
object (Config.Upload) 
上传配置
可选
imageTypes
string 
可选
允许上传的图片类型。格式如:jpg,jpeg,jfif,pjpeg,pjp,png,gif,webp
videoTypes
string 
可选
允许上传的视频类型。格式如:mp4,webm,ogg
audioTypes
string 
可选
允许上传的音频格式。格式如:mp3,ogg,wav
libraryTypes
string 
可选
允许上传的文库类型。格式如:doc,docx,xls,xlsx,ppt,pptx,pdf
docTypes
string 
可选
允许DOC导入的文库类型。格式如:doc,docx,xls,xlsx
fileTypes
string 
可选
允许上传的文件类型。格式如:zip,7z,gz,bz2,iso,rar,doc,docx,xls,xlsx,ppt,pptx,pdf,mp3,ogg,wav,mp4,webm,ogg,jpg,jpeg,jfif,pjpeg,pjp,png,gif,webp
imageLimit
integer <int32>
可选
图片最大长度。单位 MB
videoLimit
integer <int32>
可选
视频最大长度。单位 MB
audioLimit
integer <int32>
可选
音频最大长度。单位 MB
libraryLimit
integer <int32>
可选
文库最大长度。单位 MB
docLimit
integer <int32>
可选
DOC导入最大长度。单位 MB
fileLimit
integer <int32>
可选
文件最大长度。单位 MB
imageMaxWidth
integer <int32>
可选
图片最大宽度。等于 0 则不限制。默认1920
imageMaxHeight
integer <int32>
可选
图片最大高度。等于 0 则不限制。默认0
mediaLimit
integer <int32>
可选
媒体大小限制。取视频和音频中值更大的那个。
fileInputAccept
string 
可选
mediaLimitByte
integer <int64>
可选
docInputAccept
string 
可选
libraryLimitByte
integer <int64>
可选
docLimitByte
integer <int64>
可选
imageLimitByte
integer <int64>
可选
audioLimitByte
integer <int64>
可选
videoLimitByte
integer <int64>
可选
fileLimitByte
integer <int64>
可选
mediaTypes
string 
可选
媒体类型。取视频和音频的合集
videoInputAccept
string 
可选
mediaInputAccept
string 
可选
imageInputAccept
string 
可选
audioInputAccept
string 
可选
libraryInputAccept
string 
可选
grey
object (Config.Grey) 
置灰配置
可选
enabled
boolean 
可选
greyDates
string 
可选
register
object (Config.Register) 
注册配置
可选
enabled
boolean 
是否启用
可选
verifyMode
integer <int32>
可选
验证方式。1:不验证, 2:人工验证, 3:邮箱地址验证, 4:手机号码验证
usernameMinLength
integer <int32>
用户名最小长度
可选
usernameMaxLength
integer <int32>
用户名最大长度
可选
usernameRegex
string 
可选
用户名正则表达式。默认允许为 中文 数字 字符 . - _
avatar
string 
默认头像
可选
smallAvatarSize
integer <int32>
小头像尺寸
可选
mediumAvatarSize
integer <int32>
中头像尺寸
可选
largeAvatarSize
integer <int32>
大头像尺寸
可选
security
object (Config.Security) 
安全配置
可选
passwordMaxDays
integer <int32>
可选
密码最长使用天数。可以将密码设置为在某些天数(介于 1 到 999 之间)后到期,或者将天数设置为 0,指定密码永不过期。
0-999。0不限制,常用值90
>= 0<= 999
passwordMinDays
integer <int32>
可选
密码最短使用天数。可以设置一个介于 1 和 998 天之间的值,或者将天数设置为 0,允许立即更改密码。
0-998。0不限制,常用值15
>= 0<= 998
passwordWarnDays
integer <int32>
可选
密码过期提前警告天数。
0-90。0不警告,常用值7
>= 0<= 90
passwordMaxHistory
integer <int32>
可选
强制密码历史。该值必须介于 0 个和 24 个密码之间。
0-24。0不限制,常用值5
>= 0<= 24
passwordMinLength
integer <int32>
可选
密码最小长度
0-16。常用值8
>= 0<= 16
passwordMaxLength
integer <int32>
可选
密码最大长度
16-64。常用值64
>= 16<= 64
passwordStrength
integer <int32>
可选
密码强度(0:不限制; 1:大小字母+数字; 2:大写字母+小写字母+数字; 3:大小写字母+数字+特殊字符; 4:大写字母+小写字母+数字+特殊字符)
0-3。0不限制,常用值2
>= 0<= 4
userMaxAttempts
integer <int32>
可选
用户最大尝试次数
0-100。0不限制,常用值5
>= 0<= 100
userLockMinutes
integer <int32>
可选
登录锁定时间。单位分钟
1-1440,0不限制,常用值30
>= 1<= 1440
ipCaptchaAttempts
integer <int32>
可选
IP验证码次数
0-100。0必须提供验证码,常用值3
>= 0<= 100
ipMaxAttempts
integer <int32>
可选
IP允许尝试次数
0-999。0不限制,常用值10
>= 0<= 999
twoFactor
boolean 
双因子认证
可选
ssrfWhiteList
string 
SSRF白名单
可选
>= 0 字符<= 1500 字符
passwordPattern
string 
可选
ssrfList
array[string]
可选
uploadsExtensionBlacklist
string 
可选
filesExtensionBlacklist
string 
可选
customs
object 
自定义字段
可选
额外字段
object 
可选
epRank
integer <int32>
可选
uploadUrlPrefix
string 
可选
上传文件URL地址前缀
greyStyle
boolean 
是否置灰
可选
示例
{
    "id": 0,
    "contextPath": "string",
    "port": 0,
    "multiDomain": true,
    "channelUrl": "string",
    "articleUrl": "string",
    "defaultSiteId": 0,
    "upload": {
        "imageTypes": "string",
        "videoTypes": "string",
        "audioTypes": "string",
        "libraryTypes": "string",
        "docTypes": "string",
        "fileTypes": "string",
        "imageLimit": 0,
        "videoLimit": 0,
        "audioLimit": 0,
        "libraryLimit": 0,
        "docLimit": 0,
        "fileLimit": 0,
        "imageMaxWidth": 0,
        "imageMaxHeight": 0,
        "mediaLimit": 0,
        "fileInputAccept": "string",
        "mediaLimitByte": 0,
        "docInputAccept": "string",
        "libraryLimitByte": 0,
        "docLimitByte": 0,
        "imageLimitByte": 0,
        "audioLimitByte": 0,
        "videoLimitByte": 0,
        "fileLimitByte": 0,
        "mediaTypes": "string",
        "videoInputAccept": "string",
        "mediaInputAccept": "string",
        "imageInputAccept": "string",
        "audioInputAccept": "string",
        "libraryInputAccept": "string"
    },
    "grey": {
        "enabled": true,
        "greyDates": "string"
    },
    "register": {
        "enabled": true,
        "verifyMode": 0,
        "usernameMinLength": 0,
        "usernameMaxLength": 0,
        "usernameRegex": "string",
        "avatar": "string",
        "smallAvatarSize": 0,
        "mediumAvatarSize": 0,
        "largeAvatarSize": 0
    },
    "security": {
        "passwordMaxDays": 0,
        "passwordMinDays": 0,
        "passwordWarnDays": 0,
        "passwordMaxHistory": 0,
        "passwordMinLength": 0,
        "passwordMaxLength": 16,
        "passwordStrength": 0,
        "userMaxAttempts": 0,
        "userLockMinutes": 1,
        "ipCaptchaAttempts": 0,
        "ipMaxAttempts": 0,
        "twoFactor": true,
        "ssrfWhiteList": "string",
        "passwordPattern": "string",
        "ssrfList": [
            "string"
        ]
    },
    "uploadsExtensionBlacklist": "string",
    "filesExtensionBlacklist": "string",
    "customs": {
        "property1": {},
        "property2": {}
    },
    "epRank": 0,
    "uploadUrlPrefix": "string",
    "greyStyle": true
}
上一页
csrf 参数
下一页
获取客户端SM2加密 public key
Built with