程序包 | 说明 |
---|---|
com.publiccms.controller.api |
Interface controller
接口控制器
|
com.publiccms.views.directive.api |
http接口定制指令,二次开发中也可以抛弃这种方法,直接使用springmvc controller会更方便一些
|
限定符和类型 | 字段和说明 |
---|---|
private java.util.Map<java.lang.String,AbstractAppDirective> |
ApiController.appDirectiveMap |
限定符和类型 | 方法和说明 |
---|---|
void |
ApiController.init(DirectiveComponent directiveComponent,
java.util.List<AbstractAppDirective> directiveList)
接口初始化
|
限定符和类型 | 类和说明 |
---|---|
class |
AppClientDirective
appClient 客户端注册接口
参数列表
uuid :设备唯一id
clientVersion :客户端版本
使用示例
<script>
$.getJSON('${site.dynamicPath}api/appClient? |
class |
AppTokenDirective
appToken 接口访问授权Token获取接口
参数列表
appKey :应用key
appSecret :应用密钥
返回结果
appToken :接口访问授权Token
expiryDate :过期日期
error :错误信息,当appKey、appSecret为空或错误时返回【secretError】
使用示例
<script>
$.getJSON('${site.dynamicPath}api/appToken? |
class |
AutoLoginDirective
autoLogin 自动登录接口
参数列表
uuid :设备唯一id
username :用户名
channel :登陆渠道
返回结果
result :登录结果,【true,false】
authToken :用户登录授权
expiryDate :过期日期
user :用户信息 SysUser
使用示例
<script>
$.getJSON('${site.dynamicPath}api/autoLogin? |
class |
BindingUserDirective
bindingUser 客户端绑定用户接口
参数列表
uuid :设备唯一id
channel :客户端版本
返回结果
result :绑定结果
使用示例
<script>
$.getJSON('${site.dynamicPath}api/bindingUser? |
class |
ClearCacheDirective
clearCache 缓存清理接口
使用示例
<script>
$.getJSON('${site.dynamicPath}api/clearCache&appToken=接口访问授权Token', function(data){
console.log("ok");
});
</script>
|
class |
ContentCheckDirective
contentCheck 内容审核接口
参数列表
ids :多个内容id
uncheck :取消审核, 【true,false】,默认为false
返回结果
使用示例
<script>
$.getJSON('${site.dynamicPath!} |
class |
ContentClickDirective
contentClick 内容点击接口
参数列表
id :内容id
返回结果
clicks :内容点击数
使用示例
<script>
$.getJSON('${site.dynamicPath}api/contentClick? |
class |
ContentCreateDirective
contentCreate 内容创建接口
参数列表
id :内容id,为空时新建内容
categoryId :分类id
modelId :模型id
title :标题
description :标题
title :标题
author :标题
editor :编辑
copied :转载,【true,false】,默认为false
publishDate :发布日期,默认为当前日期
tagNames :多个标签名
tagIds :多个标签id
url :url,当模型为外链时有效
checked :已审核,【true,false】,默认为false
extendData :扩展数据map
source :来源
sourceUrl :来源URL
text :正文html
draft :草稿,审核为false 时有效,【true,false】,默认为false
parentId :父id,模型为子模型时有效
filePaths :多个文件路径
fileDescriptions :多个文件描述
imagePaths :多个图片路径
imageDescriptions :多个图片描述
返回结果
result :结果【failed:失败,success:成功】
contentId :内容id,当result为success时有效
error :错误,当result为failed时有效
使用示例
<script>
$.getJSON('${site.dynamicPath!} |
class |
LoginDirective
login 登录接口
参数列表
username :设备唯一id
password :用户名
encoding :密码加密方式
channel :登录渠道
返回结果
result :登录结果,【true,false】
authToken :用户登录授权
expiryDate :过期日期
user :用户信息 SysUser
使用示例
<script>
$.getJSON('${site.dynamicPath}api/login? |
class |
MyContentListDirective
myContentList 我的内容接口
参数列表
categoryId :分类id,当parentId为空时有效
containChild :是否包含子分类,【true,false】
categoryIds :多个分类id,当categoryId为空时有效
modelId :多个模型id
parentId :父内容id
onlyUrl :外链,【true,false】
hasImages :拥有图片列表,【true,false】
hasFiles :拥有附件列表,【true,false】
hasProducts :拥有产品列表,【true,false】
startPublishDate :发布日期开始时间,【2020-01-01 23:59:59】,【2020-01-01】
endPublishDate :发布日期结束时间,高级选项禁用时不能超过现在,【2020-01-01
23:59:59】,【2020-01-01】
status :内容状态,【0:操作,1:已发布,2:待审核,3:驳回】
emptyParent :高级选项:父内容id是否为空,【true,false】,当parentId为空时有效
orderField
排序字段,【score:评分,comments:评论数,clicks:点击数,publishDate:发布日期,updateDate:更新日期,checkDate:审核日期】,默认置顶级别倒序、发布日期按orderType排序
orderType :排序类型,【asc:正序,desc:倒序】,默认为倒序
pageIndex :页码
pageSize :每页条数
返回结果
page :PageHandler
page.list :List类型 查询结果实体列表
CmsContent
使用示例
<script>
$.getJSON('${site.dynamicPath!} |
class |
RefreshTokenDirective
refreshToken 刷新appToken接口
参数列表
appToken :设备唯一id
返回结果
authToken :用户登录授权
expiryDate :过期日期
error :错误信息【needNotRefresh】
使用示例
<script>
$.getJSON('${site.dynamicPath}api/login? |
class |
UnBindingUserDirective
unBindingUser 客户端绑定用户接口
参数列表
uuid :设备唯一id
channel :客户端版本
返回结果
result :取消绑定结果
使用示例
<script>
$.getJSON('${site.dynamicPath}api/unBindingUser? |