Skip to main content
体验最新特性 了解更多
IceCMS文档
Version: 中文

全部接口

Spring Boot Knife4j or swagger-bootstrap-ui API V1.0

简介:Spring Boot Knife4j or swagger-bootstrap-ui API V1.0

HOST:localhost:8181

联系人:IceCMS

Version:1.0

接口路径:/v2/api-docs?group=ICE分组

[TOC]

Web圈子分类接口

根据分类别名获取分类信息​

接口地址:/WebaSquareClass/getArticleClassByotherName/{otherName}

请求方式:GET

请求数据类型:application/x-www-form-urlencoded

响应数据类型:*/*

接口描述:

请求参数:

参数名称参数说明请求类型是否必须数据类型schema
otherNameotherNamepathtruestring

响应状态:

状态码说明schema
200OKSquareClass
401Unauthorized
403Forbidden
404Not Found

响应参数:

参数名称参数说明类型schema
describesstring
fatherinteger(int32)integer(int32)
idinteger(int32)integer(int32)
imgclassstring
isFreeboolean
namestring
numinteger(int32)integer(int32)
otherNamestring
priceinteger(int32)integer(int32)
topinteger(int32)integer(int32)

响应示例:

{
    "describes": "",
    "father": 0,
    "id": 0,
    "imgclass": "",
    "isFree": true,
    "name": "",
    "num": 0,
    "otherName": "",
    "price": 0,
    "top": 0
}

根据分类id获取文章数量​

接口地址:/WebaSquareClass/getArticleClassNum/{id}

请求方式:GET

请求数据类型:application/x-www-form-urlencoded

响应数据类型:*/*

接口描述:

请求参数:

参数名称参数说明请求类型是否必须数据类型schema
ididpathtruestring

响应状态:

状态码说明schema
200OK
401Unauthorized
403Forbidden
404Not Found

响应参数:

暂无

响应示例:


获取全部分类列表​

接口地址:/WebaSquareClass/getSquareClasslist

请求方式:GET

请求数据类型:application/x-www-form-urlencoded

响应数据类型:*/*

接口描述:

请求参数:

暂无

响应状态:

状态码说明schema
200OKSquareClass
401Unauthorized
403Forbidden
404Not Found

响应参数:

参数名称参数说明类型schema
describesstring
fatherinteger(int32)integer(int32)
idinteger(int32)integer(int32)
imgclassstring
isFreeboolean
namestring
numinteger(int32)integer(int32)
otherNamestring
priceinteger(int32)integer(int32)
topinteger(int32)integer(int32)

响应示例:

[
    {
        "describes": "",
        "father": 0,
        "id": 0,
        "imgclass": "",
        "isFree": true,
        "name": "",
        "num": 0,
        "otherName": "",
        "price": 0,
        "top": 0
    }
]

Web圈子广场接口

新增圈子​

接口地址:/Websquare/create/{SortName}

请求方式:POST

请求数据类型:application/json

响应数据类型:*/*

接口描述:

请求参数:

参数名称参数说明请求类型是否必须数据类型schema
SortNameSortNamepathtruestring
square圈子对象bodytruestring

响应状态:

状态码说明schema
200OK
201Created
401Unauthorized
403Forbidden
404Not Found

响应参数:

暂无

响应示例:


根据别名获取全部圈子(分页)​

接口地址:/Websquare/getAllSquare/{otherName}/{page}/{limit}

请求方式:GET

请求数据类型:application/x-www-form-urlencoded

响应数据类型:*/*

接口描述:

请求参数:

参数名称参数说明请求类型是否必须数据类型schema
limitlimitpathtrueinteger(int32)
otherNameotherNamepathtruestring
pagepagepathtrueinteger(int32)

响应状态:

状态码说明schema
200OKSquarePageVO
401Unauthorized
403Forbidden
404Not Found

响应参数:

参数名称参数说明类型schema
dataarraySquareVO
  addTime创建时间string
  authorstring
  authorImgstring
  commentDisabledstring
  commentNuminteger(int32)
  contentstring
  copyfromstring
  createTime生成时间string
  deletedinteger(int32)
  hitsinteger(int32)
  httpUrlstring
  idinteger(int32)
  inputerstring
  iseliteinteger(int32)
  keywordstring
  lastPost最后评论时间string
  loveNuminteger(int32)
  mediastring
  ontopinteger(int32)
  postNuminteger(int32)
  sortClassstring
  sortNamestring
  titlestring
  titleColorstring
  titlefontSizestring
  titlefontTypeinteger(int32)
  typeinteger(int32)
  updateTime更新时间string
  useridinteger(int32)
pagesinteger(int64)integer(int64)
totalinteger(int64)integer(int64)

响应示例:

{
    "data": [
        {
            "addTime": "",
            "author": "",
            "authorImg": "",
            "commentDisabled": "",
            "commentNum": 0,
            "content": "",
            "copyfrom": "",
            "createTime": "",
            "deleted": 0,
            "hits": 0,
            "httpUrl": "",
            "id": 0,
            "inputer": "",
            "iselite": 0,
            "keyword": "",
            "lastPost": "",
            "loveNum": 0,
            "media": "",
            "ontop": 0,
            "postNum": 0,
            "sortClass": "",
            "sortName": "",
            "title": "",
            "titleColor": "",
            "titlefontSize": "",
            "titlefontType": 0,
            "type": 0,
            "updateTime": "",
            "userid": 0
        }
    ],
    "pages": 0,
    "total": 0
}

根据id获取圈子内容​

接口地址:/Websquare/getSquareById/{id}

请求方式:GET

请求数据类型:application/x-www-form-urlencoded

响应数据类型:*/*

接口描述:

请求参数:

参数名称参数说明请求类型是否必须数据类型schema
id圈子idpathtruestring

响应状态:

状态码说明schema
200OKSquareVO
401Unauthorized
403Forbidden
404Not Found

响应参数:

参数名称参数说明类型schema
addTime创建时间string
authorstring
authorImgstring
commentDisabledstring
commentNuminteger(int32)integer(int32)
contentstring
copyfromstring
createTime生成时间string
deletedinteger(int32)integer(int32)
hitsinteger(int32)integer(int32)
httpUrlstring
idinteger(int32)integer(int32)
inputerstring
iseliteinteger(int32)integer(int32)
keywordstring
lastPost最后评论时间string
loveNuminteger(int32)integer(int32)
mediastring
ontopinteger(int32)integer(int32)
postNuminteger(int32)integer(int32)
sortClassstring
sortNamestring
titlestring
titleColorstring
titlefontSizestring
titlefontTypeinteger(int32)integer(int32)
typeinteger(int32)integer(int32)
updateTime更新时间string
useridinteger(int32)integer(int32)

响应示例:

{
    "addTime": "",
    "author": "",
    "authorImg": "",
    "commentDisabled": "",
    "commentNum": 0,
    "content": "",
    "copyfrom": "",
    "createTime": "",
    "deleted": 0,
    "hits": 0,
    "httpUrl": "",
    "id": 0,
    "inputer": "",
    "iselite": 0,
    "keyword": "",
    "lastPost": "",
    "loveNum": 0,
    "media": "",
    "ontop": 0,
    "postNum": 0,
    "sortClass": "",
    "sortName": "",
    "title": "",
    "titleColor": "",
    "titlefontSize": "",
    "titlefontType": 0,
    "type": 0,
    "updateTime": "",
    "userid": 0
}

评论点赞​

接口地址:/Websquare/likeClickComment/{id}

请求方式:GET

请求数据类型:application/x-www-form-urlencoded

响应数据类型:*/*

接口描述:

请求参数:

参数名称参数说明请求类型是否必须数据类型schema
id评论idpathtruestring

响应状态:

状态码说明schema
200OK
401Unauthorized
403Forbidden
404Not Found

响应参数:

暂无

响应示例:


Web圈子评论接口

增加评论​

接口地址:/WebSquareComment/addPlanetComment

请求方式:POST

请求数据类型:application/json

响应数据类型:*/*

接口描述:

请求示例:

{
  "addTime": "",
  "content": "",
  "id": 0,
  "loveNum": 0,
  "parentId": 0,
  "postId": 0,
  "profile": "",
  "responder": "",
  "responderId": 0,
  "reviewers": "",
  "reviewersId": 0,
  "status": 0,
  "toUserId": 0,
  "type": 0,
  "userId": 0
}

请求参数:

参数名称参数说明请求类型是否必须数据类型schema
PlanetComment评论分类对象truestring
SquareCommentSquareCommentbodytrueSquareCommentSquareComment
  addTime创建时间falsestring
  contentfalsestring
  idfalseinteger(int32)
  loveNumfalseinteger(int32)
  parentIdfalseinteger(int32)
  postIdfalseinteger(int32)
  profilefalsestring
  responderfalsestring
  responderIdfalseinteger(int32)
  reviewersfalsestring
  reviewersIdfalseinteger(int32)
  statusfalseinteger(int32)
  toUserIdfalseinteger(int32)
  typefalseinteger(int32)
  userIdfalseinteger(int32)

响应状态:

状态码说明schema
200OK
201Created
401Unauthorized
403Forbidden
404Not Found

响应参数:

暂无

响应示例:


根据文章id查看对应评论数​

接口地址:/WebSquareComment/getPlanetCommentnum/{planetId}

请求方式:GET

请求数据类型:application/x-www-form-urlencoded

响应数据类型:*/*

接口描述:

请求参数:

参数名称参数说明请求类型是否必须数据类型schema
planetId评论idpathtruestring

响应状态:

状态码说明schema
200OK
401Unauthorized
403Forbidden
404Not Found

响应参数:

暂无

响应示例:


根据文章id查询评论​

接口地址:/WebSquareComment/getPlanetIdComment/{postId}

请求方式:GET

请求数据类型:application/x-www-form-urlencoded

响应数据类型:*/*

接口描述:

请求参数:

参数名称参数说明请求类型是否必须数据类型schema
postIdpostIdpathtruestring

响应状态:

状态码说明schema
200OKSquareCommentVO
401Unauthorized
403Forbidden
404Not Found

响应参数:

参数名称参数说明类型schema
addTime创建时间string
contentstring
idinteger(int32)integer(int32)
loveNuminteger(int32)integer(int32)
parentIdinteger(int32)integer(int32)
postIdinteger(int32)integer(int32)
profilestring
replyarraySquareComment
  addTime创建时间string
  contentstring
  idinteger(int32)
  loveNuminteger(int32)
  parentIdinteger(int32)
  postIdinteger(int32)
  profilestring
  responderstring
  responderIdinteger(int32)
  reviewersstring
  reviewersIdinteger(int32)
  statusinteger(int32)
  toUserIdinteger(int32)
  typeinteger(int32)
  userIdinteger(int32)
responderstring
responderIdinteger(int32)integer(int32)
reviewersstring
reviewersIdinteger(int32)integer(int32)
statusinteger(int32)integer(int32)
toUserIdinteger(int32)integer(int32)
userIdinteger(int32)integer(int32)

响应示例:

[
    {
        "addTime": "",
        "content": "",
        "id": 0,
        "loveNum": 0,
        "parentId": 0,
        "postId": 0,
        "profile": "",
        "reply": [
            {
                "addTime": "",
                "content": "",
                "id": 0,
                "loveNum": 0,
                "parentId": 0,
                "postId": 0,
                "profile": "",
                "responder": "",
                "responderId": 0,
                "reviewers": "",
                "reviewersId": 0,
                "status": 0,
                "toUserId": 0,
                "type": 0,
                "userId": 0
            }
        ],
        "responder": "",
        "responderId": 0,
        "reviewers": "",
        "reviewersId": 0,
        "status": 0,
        "toUserId": 0,
        "userId": 0
    }
]

评论点赞​

接口地址:/WebSquareComment/likeClickComment/{id}

请求方式:GET

请求数据类型:application/x-www-form-urlencoded

响应数据类型:*/*

接口描述:

请求参数:

参数名称参数说明请求类型是否必须数据类型schema
id评论idpathtruestring

响应状态:

状态码说明schema
200OK
401Unauthorized
403Forbidden
404Not Found

响应参数:

暂无

响应示例:


Web文章分类接口

根据分类id获取文章数量​

接口地址:/WebarticleClass/getArticleClassNum/{id}

请求方式:GET

请求数据类型:application/x-www-form-urlencoded

响应数据类型:*/*

接口描述:

请求参数:

参数名称参数说明请求类型是否必须数据类型schema
ididpathtruestring

响应状态:

状态码说明schema
200OK
401Unauthorized
403Forbidden
404Not Found

响应参数:

暂无

响应示例:


获取全部分类列表​

接口地址:/WebarticleClass/getArticleClasslist

请求方式:GET

请求数据类型:application/x-www-form-urlencoded

响应数据类型:*/*

接口描述:

请求参数:

暂无

响应状态:

状态码说明schema
200OKArticleClass
401Unauthorized
403Forbidden
404Not Found

响应参数:

参数名称参数说明类型schema
describesstring
fatherinteger(int32)integer(int32)
idinteger(int32)integer(int32)
imgclassstring
namestring
numinteger(int32)integer(int32)
otherNamestring
topinteger(int32)integer(int32)

响应示例:

[
    {
        "describes": "",
        "father": 0,
        "id": 0,
        "imgclass": "",
        "name": "",
        "num": 0,
        "otherName": "",
        "top": 0
    }
]

Web文章接口

查询文章(分页)​

接口地址:/WebArticle/FindAllArticle/{content}/{page}/{limit}

请求方式:GET

请求数据类型:application/x-www-form-urlencoded

响应数据类型:*/*

接口描述:

请求参数:

参数名称参数说明请求类型是否必须数据类型schema
content内容pathtruestring
limit总量pathtruestring
page页数pathtruestring

响应状态:

状态码说明schema
200OKArticlePageVO
401Unauthorized
403Forbidden
404Not Found

响应参数:

参数名称参数说明类型schema
dataarrayArticleVO
  addTimestring(date-time)
  authorstring
  classNamestring
  commentNuminteger(int32)
  createTimestring(date-time)
  hitsinteger(int32)
  idinteger(int32)
  ownerTaginteger(int32)
  postNuminteger(int32)
  profilestring
  sortClassstring
  statusstring
  thumbstring
  titlestring
pagesinteger(int64)integer(int64)
totalinteger(int64)integer(int64)

响应示例:

{
    "data": [
        {
            "addTime": "",
            "author": "",
            "className": "",
            "commentNum": 0,
            "createTime": "",
            "hits": 0,
            "id": 0,
            "ownerTag": 0,
            "postNum": 0,
            "profile": "",
            "sortClass": "",
            "status": "",
            "thumb": "",
            "title": ""
        }
    ],
    "pages": 0,
    "total": 0
}

根据作者name查询对应头像​

接口地址:/WebArticle/FindProfileByName/{name}

请求方式:GET

请求数据类型:application/x-www-form-urlencoded

响应数据类型:*/*

接口描述:

请求参数:

参数名称参数说明请求类型是否必须数据类型schema
name作者名称pathtruestring

响应状态:

状态码说明schema
200OK
401Unauthorized
403Forbidden
404Not Found

响应参数:

暂无

响应示例:


获取重要文章​

接口地址:/WebArticle/GetArticleBtmatter

请求方式:GET

请求数据类型:application/x-www-form-urlencoded

响应数据类型:*/*

接口描述:

请求参数:

暂无

响应状态:

状态码说明schema
200OKArticleVO
401Unauthorized
403Forbidden
404Not Found

响应参数:

参数名称参数说明类型schema
addTimestring(date-time)string(date-time)
authorstring
classNamestring
commentNuminteger(int32)integer(int32)
createTimestring(date-time)string(date-time)
hitsinteger(int32)integer(int32)
idinteger(int32)integer(int32)
ownerTaginteger(int32)integer(int32)
postNuminteger(int32)integer(int32)
profilestring
sortClassstring
statusstring
thumbstring
titlestring

响应示例:

[
    {
        "addTime": "",
        "author": "",
        "className": "",
        "commentNum": 0,
        "createTime": "",
        "hits": 0,
        "id": 0,
        "ownerTag": 0,
        "postNum": 0,
        "profile": "",
        "sortClass": "",
        "status": "",
        "thumb": "",
        "title": ""
    }
]

统计文章喜欢量+1​

接口地址:/WebArticle/articles/{id}/love

请求方式:GET

请求数据类型:application/x-www-form-urlencoded

响应数据类型:*/*

接口描述:

请求参数:

参数名称参数说明请求类型是否必须数据类型schema
id文章idpathtruestring

响应状态:

状态码说明schema
200OK
401Unauthorized
403Forbidden
404Not Found

响应参数:

暂无

响应示例:


统计文章浏览量+1​

接口地址:/WebArticle/articles/{id}/view

请求方式:GET

请求数据类型:application/x-www-form-urlencoded

响应数据类型:*/*

接口描述:

请求参数:

参数名称参数说明请求类型是否必须数据类型schema
id文章idpathtruestring

响应状态:

状态码说明schema
200OK
401Unauthorized
403Forbidden
404Not Found

响应参数:

暂无

响应示例:


文章查询(全部)​

接口地址:/WebArticle/findarticles/{content}

请求方式:GET

请求数据类型:application/x-www-form-urlencoded

响应数据类型:*/*

接口描述:

请求参数:

参数名称参数说明请求类型是否必须数据类型schema
content模糊查询标题pathtruestring

响应状态:

状态码说明schema
200OKArticle
401Unauthorized
403Forbidden
404Not Found

响应参数:

参数名称参数说明类型schema
addTime创建时间string
articleStatusinteger(int32)integer(int32)
authorstring
commentDisabledstring
contentstring
copyfromstring
createTime生成时间string
deletedinteger(int32)integer(int32)
filePathstring
fullTitlestring
hitsinteger(int32)integer(int32)
htmlPathstring
httpUrlstring
idinteger(int32)integer(int32)
inputerstring
introstring
iseliteinteger(int32)integer(int32)
keywordstring
lastPost最后评论时间string
loveNuminteger(int32)integer(int32)
ontopinteger(int32)integer(int32)
ownerRemarkstring
ownerTaginteger(int32)integer(int32)
postNuminteger(int32)integer(int32)
sortClassstring
statusstring
subheadstring
tempPathstring
thumbstring
titlestring
titleColorstring
titlefontSizestring
titlefontTypeinteger(int32)integer(int32)
updateTime更新时间string

响应示例:

[
    {
        "addTime": "",
        "articleStatus": 0,
        "author": "",
        "commentDisabled": "",
        "content": "",
        "copyfrom": "",
        "createTime": "",
        "deleted": 0,
        "filePath": "",
        "fullTitle": "",
        "hits": 0,
        "htmlPath": "",
        "httpUrl": "",
        "id": 0,
        "inputer": "",
        "intro": "",
        "iselite": 0,
        "keyword": "",
        "lastPost": "",
        "loveNum": 0,
        "ontop": 0,
        "ownerRemark": "",
        "ownerTag": 0,
        "postNum": 0,
        "sortClass": "",
        "status": "",
        "subhead": "",
        "tempPath": "",
        "thumb": "",
        "title": "",
        "titleColor": "",
        "titlefontSize": "",
        "titlefontType": 0,
        "updateTime": ""
    }
]

文章查询(预览)​

接口地址:/WebArticle/findarticlesbynum/{content}/{num}

请求方式:GET

请求数据类型:application/x-www-form-urlencoded

响应数据类型:*/*

接口描述:

请求参数:

参数名称参数说明请求类型是否必须数据类型schema
content模糊查询标题pathtruestring
numnumpathtruestring

响应状态:

状态码说明schema
200OKArticle
401Unauthorized
403Forbidden
404Not Found

响应参数:

参数名称参数说明类型schema
addTime创建时间string
articleStatusinteger(int32)integer(int32)
authorstring
commentDisabledstring
contentstring
copyfromstring
createTime生成时间string
deletedinteger(int32)integer(int32)
filePathstring
fullTitlestring
hitsinteger(int32)integer(int32)
htmlPathstring
httpUrlstring
idinteger(int32)integer(int32)
inputerstring
introstring
iseliteinteger(int32)integer(int32)
keywordstring
lastPost最后评论时间string
loveNuminteger(int32)integer(int32)
ontopinteger(int32)integer(int32)
ownerRemarkstring
ownerTaginteger(int32)integer(int32)
postNuminteger(int32)integer(int32)
sortClassstring
statusstring
subheadstring
tempPathstring
thumbstring
titlestring
titleColorstring
titlefontSizestring
titlefontTypeinteger(int32)integer(int32)
updateTime更新时间string

响应示例:

[
    {
        "addTime": "",
        "articleStatus": 0,
        "author": "",
        "commentDisabled": "",
        "content": "",
        "copyfrom": "",
        "createTime": "",
        "deleted": 0,
        "filePath": "",
        "fullTitle": "",
        "hits": 0,
        "htmlPath": "",
        "httpUrl": "",
        "id": 0,
        "inputer": "",
        "intro": "",
        "iselite": 0,
        "keyword": "",
        "lastPost": "",
        "loveNum": 0,
        "ontop": 0,
        "ownerRemark": "",
        "ownerTag": 0,
        "postNum": 0,
        "sortClass": "",
        "status": "",
        "subhead": "",
        "tempPath": "",
        "thumb": "",
        "title": "",
        "titleColor": "",
        "titlefontSize": "",
        "titlefontType": 0,
        "updateTime": ""
    }
]

获取全部文章列表(分页)​

接口地址:/WebArticle/getAllArticle/{page}/{limit}/{click}

请求方式:GET

请求数据类型:application/x-www-form-urlencoded

响应数据类型:*/*

接口描述:

请求参数:

参数名称参数说明请求类型是否必须数据类型schema
clickclickpathtrueinteger(int32)
limit总量pathtruestring
page页数pathtruestring

响应状态:

状态码说明schema
200OKArticlePageVO
401Unauthorized
403Forbidden
404Not Found

响应参数:

参数名称参数说明类型schema
dataarrayArticleVO
  addTimestring(date-time)
  authorstring
  classNamestring
  commentNuminteger(int32)
  createTimestring(date-time)
  hitsinteger(int32)
  idinteger(int32)
  ownerTaginteger(int32)
  postNuminteger(int32)
  profilestring
  sortClassstring
  statusstring
  thumbstring
  titlestring
pagesinteger(int64)integer(int64)
totalinteger(int64)integer(int64)

响应示例:

{
    "data": [
        {
            "addTime": "",
            "author": "",
            "className": "",
            "commentNum": 0,
            "createTime": "",
            "hits": 0,
            "id": 0,
            "ownerTag": 0,
            "postNum": 0,
            "profile": "",
            "sortClass": "",
            "status": "",
            "thumb": "",
            "title": ""
        }
    ],
    "pages": 0,
    "total": 0
}

获取所有文章数量​

接口地址:/WebArticle/getAllArticleNumber

请求方式:GET

请求数据类型:application/x-www-form-urlencoded

响应数据类型:*/*

接口描述:

请求参数:

暂无

响应状态:

状态码说明schema
200OK
401Unauthorized
403Forbidden
404Not Found

响应参数:

暂无

响应示例:


根据id获取文章内容​

接口地址:/WebArticle/getArticleById/{id}

请求方式:GET

请求数据类型:application/x-www-form-urlencoded

响应数据类型:*/*

接口描述:

请求参数:

参数名称参数说明请求类型是否必须数据类型schema
id文章idpathtruestring

响应状态:

状态码说明schema
200OKArticle
401Unauthorized
403Forbidden
404Not Found

响应参数:

参数名称参数说明类型schema
addTime创建时间string
articleStatusinteger(int32)integer(int32)
authorstring
commentDisabledstring
contentstring
copyfromstring
createTime生成时间string
deletedinteger(int32)integer(int32)
filePathstring
fullTitlestring
hitsinteger(int32)integer(int32)
htmlPathstring
httpUrlstring
idinteger(int32)integer(int32)
inputerstring
introstring
iseliteinteger(int32)integer(int32)
keywordstring
lastPost最后评论时间string
loveNuminteger(int32)integer(int32)
ontopinteger(int32)integer(int32)
ownerRemarkstring
ownerTaginteger(int32)integer(int32)
postNuminteger(int32)integer(int32)
sortClassstring
statusstring
subheadstring
tempPathstring
thumbstring
titlestring
titleColorstring
titlefontSizestring
titlefontTypeinteger(int32)integer(int32)
updateTime更新时间string

响应示例:

{
    "addTime": "",
    "articleStatus": 0,
    "author": "",
    "commentDisabled": "",
    "content": "",
    "copyfrom": "",
    "createTime": "",
    "deleted": 0,
    "filePath": "",
    "fullTitle": "",
    "hits": 0,
    "htmlPath": "",
    "httpUrl": "",
    "id": 0,
    "inputer": "",
    "intro": "",
    "iselite": 0,
    "keyword": "",
    "lastPost": "",
    "loveNum": 0,
    "ontop": 0,
    "ownerRemark": "",
    "ownerTag": 0,
    "postNum": 0,
    "sortClass": "",
    "status": "",
    "subhead": "",
    "tempPath": "",
    "thumb": "",
    "title": "",
    "titleColor": "",
    "titlefontSize": "",
    "titlefontType": 0,
    "updateTime": ""
}

获取文章下一页(标题)​

接口地址:/WebArticle/getLastnewsArticle/{id}

请求方式:GET

请求数据类型:application/x-www-form-urlencoded

响应数据类型:*/*

接口描述:

请求参数:

参数名称参数说明请求类型是否必须数据类型schema
ididpathtruestring

响应状态:

状态码说明schema
200OK
401Unauthorized
403Forbidden
404Not Found

响应参数:

暂无

响应示例:


获取最新文章列表​

接口地址:/WebArticle/getNewArticle/{articleNum}/{check}

请求方式:GET

请求数据类型:application/x-www-form-urlencoded

响应数据类型:*/*

接口描述:

请求参数:

参数名称参数说明请求类型是否必须数据类型schema
articleNum数量pathtruestring
check条件pathtruestring

响应状态:

状态码说明schema
200OKArticleVO
401Unauthorized
403Forbidden
404Not Found

响应参数:

参数名称参数说明类型schema
addTimestring(date-time)string(date-time)
authorstring
classNamestring
commentNuminteger(int32)integer(int32)
createTimestring(date-time)string(date-time)
hitsinteger(int32)integer(int32)
idinteger(int32)integer(int32)
ownerTaginteger(int32)integer(int32)
postNuminteger(int32)integer(int32)
profilestring
sortClassstring
statusstring
thumbstring
titlestring

响应示例:

[
    {
        "addTime": "",
        "author": "",
        "className": "",
        "commentNum": 0,
        "createTime": "",
        "hits": 0,
        "id": 0,
        "ownerTag": 0,
        "postNum": 0,
        "profile": "",
        "sortClass": "",
        "status": "",
        "thumb": "",
        "title": ""
    }
]

获取文章上一页(标题)​

接口地址:/WebArticle/getPrenewsArticle/{id}

请求方式:GET

请求数据类型:application/x-www-form-urlencoded

响应数据类型:*/*

接口描述:

请求参数:

参数名称参数说明请求类型是否必须数据类型schema
ididpathtruestring

响应状态:

状态码说明schema
200OK
401Unauthorized
403Forbidden
404Not Found

响应参数:

暂无

响应示例:


Web文章评论接口

增加评论​

接口地址:/WebArticleComment/addArticleComment

请求方式:POST

请求数据类型:application/json

响应数据类型:*/*

接口描述:

请求参数:

参数名称参数说明请求类型是否必须数据类型schema
articleComment文章分类对象bodytruestring

响应状态:

状态码说明schema
200OK
201Created
401Unauthorized
403Forbidden
404Not Found

响应参数:

暂无

响应示例:


查看文章对应评论数​

接口地址:/WebArticleComment/getArticleCommentnum/{articleId}

请求方式:GET

请求数据类型:application/x-www-form-urlencoded

响应数据类型:*/*

接口描述:

请求参数:

参数名称参数说明请求类型是否必须数据类型schema
articleId文章idpathtruestring

响应状态:

状态码说明schema
200OK
401Unauthorized
403Forbidden
404Not Found

响应参数:

暂无

响应示例:


最新评论​

接口地址:/WebArticleComment/getNewArticleComment/{num}

请求方式:GET

请求数据类型:application/x-www-form-urlencoded

响应数据类型:*/*

接口描述:

请求参数:

参数名称参数说明请求类型是否必须数据类型schema
num数量pathtruestring

响应状态:

状态码说明schema
200OKArticleCommentVO
401Unauthorized
403Forbidden
404Not Found

响应参数:

参数名称参数说明类型schema
addTime创建时间string
articleIdinteger(int32)integer(int32)
articleNamestring
contentstring
emailstring
foreignIdinteger(int32)integer(int32)
idinteger(int32)integer(int32)
parentIdinteger(int32)integer(int32)
profilestring
userIdinteger(int32)integer(int32)
usernamestring

响应示例:

[
    {
        "addTime": "",
        "articleId": 0,
        "articleName": "",
        "content": "",
        "email": "",
        "foreignId": 0,
        "id": 0,
        "parentId": 0,
        "profile": "",
        "userId": 0,
        "username": ""
    }
]

根据文章id查询对应的评论​

接口地址:/WebArticleComment/getallArticleComment/{articleId}

请求方式:GET

请求数据类型:application/x-www-form-urlencoded

响应数据类型:*/*

接口描述:

请求参数:

参数名称参数说明请求类型是否必须数据类型schema
articleId文章idpathtruestring

响应状态:

状态码说明schema
200OKArticleComment
401Unauthorized
403Forbidden
404Not Found

响应参数:

参数名称参数说明类型schema
addTime创建时间string
articleIdinteger(int32)integer(int32)
contentstring
emailstring
foreignIdinteger(int32)integer(int32)
idinteger(int32)integer(int32)
parentIdinteger(int32)integer(int32)
profilestring
userIdinteger(int32)integer(int32)
usernamestring

响应示例:

[
    {
        "addTime": "",
        "articleId": 0,
        "content": "",
        "email": "",
        "foreignId": 0,
        "id": 0,
        "parentId": 0,
        "profile": "",
        "userId": 0,
        "username": ""
    }
]

Web标签接口

获取全部tag​

接口地址:/Tag/getAllTag

请求方式:GET

请求数据类型:application/x-www-form-urlencoded

响应数据类型:*/*

接口描述:

请求参数:

暂无

响应状态:

状态码说明schema
200OKAllTag
401Unauthorized
403Forbidden
404Not Found

响应参数:

参数名称参数说明类型schema
idinteger(int32)integer(int32)
tagNamestring

响应示例:

[
    {
        "id": 0,
        "tagName": ""
    }
]

获取全部tag​

接口地址:/WebTag/getAllTag

请求方式:GET

请求数据类型:application/x-www-form-urlencoded

响应数据类型:*/*

接口描述:

请求参数:

暂无

响应状态:

状态码说明schema
200OKAllTag
401Unauthorized
403Forbidden
404Not Found

响应参数:

参数名称参数说明类型schema
idinteger(int32)integer(int32)
tagNamestring

响应示例:

[
    {
        "id": 0,
        "tagName": ""
    }
]

根据id获取tag名称​

接口地址:/WebTag/getTagByList/{id}

请求方式:GET

请求数据类型:application/x-www-form-urlencoded

响应数据类型:*/*

接口描述:

请求参数:

参数名称参数说明请求类型是否必须数据类型schema
ididpathtrueinteger(int32)

响应状态:

状态码说明schema
200OKAllTag
401Unauthorized
403Forbidden
404Not Found

响应参数:

参数名称参数说明类型schema
idinteger(int32)integer(int32)
tagNamestring

响应示例:

{
    "id": 0,
    "tagName": ""
}

Web设置接口

获取首页轮播图​

接口地址:/WebSitting/getCarousel

请求方式:GET

请求数据类型:application/x-www-form-urlencoded

响应数据类型:*/*

接口描述:

请求参数:

暂无

响应状态:

状态码说明schema
200OKDispositionCarousel
401Unauthorized
403Forbidden
404Not Found

响应参数:

参数名称参数说明类型schema
buttonstring
idinteger(int32)integer(int32)
imgstring
introducestring
titlestring

响应示例:

[
    {
        "button": "",
        "id": 0,
        "img": "",
        "introduce": "",
        "title": ""
    }
]

获取所有设置​

接口地址:/WebSitting/getSetting

请求方式:GET

请求数据类型:application/x-www-form-urlencoded

响应数据类型:*/*

接口描述:

请求参数:

暂无

响应状态:

状态码说明schema
200OKSetting
401Unauthorized
403Forbidden
404Not Found

响应参数:

参数名称参数说明类型schema
banquanstring
beianstring
comment_showboolean
cosBucketNamestring
cosClientConfigstring
cosIntagestring
cosSecretIdstring
cosSecretKeystring
idinteger(int32)integer(int32)
imageFormatboolean
isCosboolean
sitLogostring
sitTitlestring

响应示例:

{
    "banquan": "",
    "beian": "",
    "comment_show": true,
    "cosBucketName": "",
    "cosClientConfig": "",
    "cosIntage": "",
    "cosSecretId": "",
    "cosSecretKey": "",
    "id": 0,
    "imageFormat": true,
    "isCos": true,
    "sitLogo": "",
    "sitTitle": ""
}

Web资源分类接口

根据classid查询对应的资源分类名称​

接口地址:/WebResourceClass/getResourceClassNameByid/{classId}

请求方式:GET

请求数据类型:application/x-www-form-urlencoded

响应数据类型:*/*

接口描述:

请求参数:

参数名称参数说明请求类型是否必须数据类型schema
classId分类idpathtruestring

响应状态:

状态码说明schema
200OK
401Unauthorized
403Forbidden
404Not Found

响应参数:

暂无

响应示例:


获取全部资源分类列表​

接口地址:/WebResourceClass/getResourceClasslist

请求方式:GET

请求数据类型:application/x-www-form-urlencoded

响应数据类型:*/*

接口描述:

请求参数:

暂无

响应状态:

状态码说明schema
200OKResourceClass
401Unauthorized
403Forbidden
404Not Found

响应参数:

参数名称参数说明类型schema
describesstring
fatherinteger(int32)integer(int32)
idinteger(int32)integer(int32)
imgclassstring
namestring
numinteger(int32)integer(int32)
otherNamestring
topinteger(int32)integer(int32)

响应示例:

[
    {
        "describes": "",
        "father": 0,
        "id": 0,
        "imgclass": "",
        "name": "",
        "num": 0,
        "otherName": "",
        "top": 0
    }
]

Web资源接口

查询资源(分页)​

接口地址:/WebResource/FindAllResource/{content}/{page}/{limit}

请求方式:GET

请求数据类型:application/x-www-form-urlencoded

响应数据类型:*/*

接口描述:

请求参数:

参数名称参数说明请求类型是否必须数据类型schema
content内容pathtruestring
limit总量pathtruestring
page页数pathtruestring

响应状态:

状态码说明schema
200OKResourcePageVO
401Unauthorized
403Forbidden
404Not Found

响应参数:

参数名称参数说明类型schema
dataarrayResourceVO
  addTimestring(date-time)
  authorstring
  authorThumbstring
  createTimestring(date-time)
  hitsinteger(int32)
  idinteger(int32)
  introstring
  ownerTaginteger(int32)
  pricestring
  profilestring
  sortClassstring
  statusstring
  subheadstring
  thumbstring
  titlestring
totalinteger(int64)integer(int64)

响应示例:

{
    "data": [
        {
            "addTime": "",
            "author": "",
            "authorThumb": "",
            "createTime": "",
            "hits": 0,
            "id": 0,
            "intro": "",
            "ownerTag": 0,
            "price": "",
            "profile": "",
            "sortClass": "",
            "status": "",
            "subhead": "",
            "thumb": "",
            "title": ""
        }
    ],
    "total": 0
}

资源查询(预览)​

接口地址:/WebResource/findresourcebynum/{content}/{num}

请求方式:GET

请求数据类型:application/x-www-form-urlencoded

响应数据类型:*/*

接口描述:

请求参数:

参数名称参数说明请求类型是否必须数据类型schema
content内容pathtruestring
num总量pathtruestring

响应状态:

状态码说明schema
200OKResource
401Unauthorized
403Forbidden
404Not Found

响应参数:

参数名称参数说明类型schema
addTime创建时间string
articleStatusinteger(int32)integer(int32)
authorstring
carouselstring
commentDisabledstring
contentstring
copyfromstring
createTime生成时间string
deletedinteger(int32)integer(int32)
filePathstring
fullTitlestring
hitsinteger(int32)integer(int32)
htmlPathstring
httpUrlstring
idinteger(int32)integer(int32)
inputerstring
introstring
isFreeboolean
iseliteinteger(int32)integer(int32)
keywordstring
lastPost最后评论时间string
loveNuminteger(int32)integer(int32)
ontopinteger(int32)integer(int32)
ownerRemarkstring
ownerTaginteger(int32)integer(int32)
postNuminteger(int32)integer(int32)
pricestring
resAddressstring
resPasswordstring
sortClassstring
statusstring
subheadstring
tempPathstring
thumbstring
titlestring
titleColorstring
titlefontSizestring
titlefontTypeinteger(int32)integer(int32)
updateTime更新时间string

响应示例:

[
    {
        "addTime": "",
        "articleStatus": 0,
        "author": "",
        "carousel": "",
        "commentDisabled": "",
        "content": "",
        "copyfrom": "",
        "createTime": "",
        "deleted": 0,
        "filePath": "",
        "fullTitle": "",
        "hits": 0,
        "htmlPath": "",
        "httpUrl": "",
        "id": 0,
        "inputer": "",
        "intro": "",
        "isFree": true,
        "iselite": 0,
        "keyword": "",
        "lastPost": "",
        "loveNum": 0,
        "ontop": 0,
        "ownerRemark": "",
        "ownerTag": 0,
        "postNum": 0,
        "price": "",
        "resAddress": "",
        "resPassword": "",
        "sortClass": "",
        "status": "",
        "subhead": "",
        "tempPath": "",
        "thumb": "",
        "title": "",
        "titleColor": "",
        "titlefontSize": "",
        "titlefontType": 0,
        "updateTime": ""
    }
]

获取全部资源列表(分页)​

接口地址:/WebResource/getAllResource/{page}/{limit}

请求方式:GET

请求数据类型:application/x-www-form-urlencoded

响应数据类型:*/*

接口描述:

请求参数:

参数名称参数说明请求类型是否必须数据类型schema
limit总量pathtruestring
page页数pathtruestring

响应状态:

状态码说明schema
200OKResourcePageVO
401Unauthorized
403Forbidden
404Not Found

响应参数:

参数名称参数说明类型schema
dataarrayResourceVO
  addTimestring(date-time)
  authorstring
  authorThumbstring
  createTimestring(date-time)
  hitsinteger(int32)
  idinteger(int32)
  introstring
  ownerTaginteger(int32)
  pricestring
  profilestring
  sortClassstring
  statusstring
  subheadstring
  thumbstring
  titlestring
totalinteger(int64)integer(int64)

响应示例:

{
    "data": [
        {
            "addTime": "",
            "author": "",
            "authorThumb": "",
            "createTime": "",
            "hits": 0,
            "id": 0,
            "intro": "",
            "ownerTag": 0,
            "price": "",
            "profile": "",
            "sortClass": "",
            "status": "",
            "subhead": "",
            "thumb": "",
            "title": ""
        }
    ],
    "total": 0
}

获取所有资源数量​

接口地址:/WebResource/getAllResourceNumber

请求方式:GET

请求数据类型:application/x-www-form-urlencoded

响应数据类型:*/*

接口描述:

请求参数:

暂无

响应状态:

状态码说明schema
200OK
401Unauthorized
403Forbidden
404Not Found

响应参数:

暂无

响应示例:


获取文章下一页(标题)​

接口地址:/WebResource/getLastnewsResource/{id}

请求方式:GET

请求数据类型:application/x-www-form-urlencoded

响应数据类型:*/*

接口描述:

请求参数:

参数名称参数说明请求类型是否必须数据类型schema
ididpathtruestring

响应状态:

状态码说明schema
200OK
401Unauthorized
403Forbidden
404Not Found

响应参数:

暂无

响应示例:


获取最新资源列表​

接口地址:/WebResource/getNewResource/{resourceNum}/{filter}

请求方式:GET

请求数据类型:application/x-www-form-urlencoded

响应数据类型:*/*

接口描述:

请求参数:

参数名称参数说明请求类型是否必须数据类型schema
articleNum数量truestring
filterfilterpathtruestring
resourceNumresourceNumpathtrueinteger(int32)

响应状态:

状态码说明schema
200OKResourceVO
401Unauthorized
403Forbidden
404Not Found

响应参数:

参数名称参数说明类型schema
addTimestring(date-time)string(date-time)
authorstring
authorThumbstring
createTimestring(date-time)string(date-time)
hitsinteger(int32)integer(int32)
idinteger(int32)integer(int32)
introstring
ownerTaginteger(int32)integer(int32)
pricestring
profilestring
sortClassstring
statusstring
subheadstring
thumbstring
titlestring

响应示例:

[
    {
        "addTime": "",
        "author": "",
        "authorThumb": "",
        "createTime": "",
        "hits": 0,
        "id": 0,
        "intro": "",
        "ownerTag": 0,
        "price": "",
        "profile": "",
        "sortClass": "",
        "status": "",
        "subhead": "",
        "thumb": "",
        "title": ""
    }
]

获取文章上一页(标题)​

接口地址:/WebResource/getPrenewsResource/{id}

请求方式:GET

请求数据类型:application/x-www-form-urlencoded

响应数据类型:*/*

接口描述:

请求参数:

参数名称参数说明请求类型是否必须数据类型schema
ididpathtruestring

响应状态:

状态码说明schema
200OK
401Unauthorized
403Forbidden
404Not Found

响应参数:

暂无

响应示例:


根据分类id获取资源内容​

接口地址:/WebResource/getResourceByClassId/{id}

请求方式:GET

请求数据类型:application/x-www-form-urlencoded

响应数据类型:*/*

接口描述:

请求参数:

参数名称参数说明请求类型是否必须数据类型schema
id分类idpathtruestring

响应状态:

状态码说明schema
200OKResourceVO
401Unauthorized
403Forbidden
404Not Found

响应参数:

参数名称参数说明类型schema
addTimestring(date-time)string(date-time)
authorstring
authorThumbstring
createTimestring(date-time)string(date-time)
hitsinteger(int32)integer(int32)
idinteger(int32)integer(int32)
introstring
ownerTaginteger(int32)integer(int32)
pricestring
profilestring
sortClassstring
statusstring
subheadstring
thumbstring
titlestring

响应示例:

[
    {
        "addTime": "",
        "author": "",
        "authorThumb": "",
        "createTime": "",
        "hits": 0,
        "id": 0,
        "intro": "",
        "ownerTag": 0,
        "price": "",
        "profile": "",
        "sortClass": "",
        "status": "",
        "subhead": "",
        "thumb": "",
        "title": ""
    }
]

根据id获取资源内容​

接口地址:/WebResource/getResourceById/{id}

请求方式:GET

请求数据类型:application/x-www-form-urlencoded

响应数据类型:*/*

接口描述:

请求参数:

参数名称参数说明请求类型是否必须数据类型schema
id资源idpathtruestring

响应状态:

状态码说明schema
200OKResource
401Unauthorized
403Forbidden
404Not Found

响应参数:

参数名称参数说明类型schema
addTime创建时间string
articleStatusinteger(int32)integer(int32)
authorstring
carouselstring
commentDisabledstring
contentstring
copyfromstring
createTime生成时间string
deletedinteger(int32)integer(int32)
filePathstring
fullTitlestring
hitsinteger(int32)integer(int32)
htmlPathstring
httpUrlstring
idinteger(int32)integer(int32)
inputerstring
introstring
isFreeboolean
iseliteinteger(int32)integer(int32)
keywordstring
lastPost最后评论时间string
loveNuminteger(int32)integer(int32)
ontopinteger(int32)integer(int32)
ownerRemarkstring
ownerTaginteger(int32)integer(int32)
postNuminteger(int32)integer(int32)
pricestring
resAddressstring
resPasswordstring
sortClassstring
statusstring
subheadstring
tempPathstring
thumbstring
titlestring
titleColorstring
titlefontSizestring
titlefontTypeinteger(int32)integer(int32)
updateTime更新时间string

响应示例:

{
    "addTime": "",
    "articleStatus": 0,
    "author": "",
    "carousel": "",
    "commentDisabled": "",
    "content": "",
    "copyfrom": "",
    "createTime": "",
    "deleted": 0,
    "filePath": "",
    "fullTitle": "",
    "hits": 0,
    "htmlPath": "",
    "httpUrl": "",
    "id": 0,
    "inputer": "",
    "intro": "",
    "isFree": true,
    "iselite": 0,
    "keyword": "",
    "lastPost": "",
    "loveNum": 0,
    "ontop": 0,
    "ownerRemark": "",
    "ownerTag": 0,
    "postNum": 0,
    "price": "",
    "resAddress": "",
    "resPassword": "",
    "sortClass": "",
    "status": "",
    "subhead": "",
    "tempPath": "",
    "thumb": "",
    "title": "",
    "titleColor": "",
    "titlefontSize": "",
    "titlefontType": 0,
    "updateTime": ""
}

根据分类ID获取全部资源列表(分页)​

接口地址:/WebResource/getResourceFilter/{page}/{limit}/{rclass}/{filter}

请求方式:GET

请求数据类型:application/x-www-form-urlencoded

响应数据类型:*/*

接口描述:

请求参数:

参数名称参数说明请求类型是否必须数据类型schema
class类别truestring
filter条件pathtruestring
limit总量pathtruestring
page页数pathtruestring
rclassrclasspathtrueinteger(int32)

响应状态:

状态码说明schema
200OKResourcePageVO
401Unauthorized
403Forbidden
404Not Found

响应参数:

参数名称参数说明类型schema
dataarrayResourceVO
  addTimestring(date-time)
  authorstring
  authorThumbstring
  createTimestring(date-time)
  hitsinteger(int32)
  idinteger(int32)
  introstring
  ownerTaginteger(int32)
  pricestring
  profilestring
  sortClassstring
  statusstring
  subheadstring
  thumbstring
  titlestring
totalinteger(int64)integer(int64)

响应示例:

{
    "data": [
        {
            "addTime": "",
            "author": "",
            "authorThumb": "",
            "createTime": "",
            "hits": 0,
            "id": 0,
            "intro": "",
            "ownerTag": 0,
            "price": "",
            "profile": "",
            "sortClass": "",
            "status": "",
            "subhead": "",
            "thumb": "",
            "title": ""
        }
    ],
    "total": 0
}

统计资源喜欢量+1​

接口地址:/WebResource/resource/{id}/love

请求方式:GET

请求数据类型:application/x-www-form-urlencoded

响应数据类型:*/*

接口描述:

请求参数:

参数名称参数说明请求类型是否必须数据类型schema
id资源idpathtruestring

响应状态:

状态码说明schema
200OK
401Unauthorized
403Forbidden
404Not Found

响应参数:

暂无

响应示例:


统计资源浏览量+1​

接口地址:/WebResource/resource/{id}/view

请求方式:GET

请求数据类型:application/x-www-form-urlencoded

响应数据类型:*/*

接口描述:

请求参数:

参数名称参数说明请求类型是否必须数据类型schema
id资源idpathtruestring

响应状态:

状态码说明schema
200OK
401Unauthorized
403Forbidden
404Not Found

响应参数:

暂无

响应示例:


Web资源评论接口

增加评论​

接口地址:/WebResourceComment/addResourceComment

请求方式:POST

请求数据类型:application/json

响应数据类型:*/*

接口描述:

请求参数:

参数名称参数说明请求类型是否必须数据类型schema
resourceComment资源分类对象bodytruestring

响应状态:

状态码说明schema
200OK
201Created
401Unauthorized
403Forbidden
404Not Found

响应参数:

暂无

响应示例:


查看文章对应评论数​

接口地址:/WebResourceComment/getResourceCommentnum/{resourceId}

请求方式:GET

请求数据类型:application/x-www-form-urlencoded

响应数据类型:*/*

接口描述:

请求参数:

参数名称参数说明请求类型是否必须数据类型schema
resourceId资源idpathtruestring

响应状态:

状态码说明schema
200OK
401Unauthorized
403Forbidden
404Not Found

响应参数:

暂无

响应示例:


根据资源id查询对应的评论​

接口地址:/WebResourceComment/getallResourceComment/{resourceId}

请求方式:GET

请求数据类型:application/x-www-form-urlencoded

响应数据类型:*/*

接口描述:

请求参数:

参数名称参数说明请求类型是否必须数据类型schema
resourceId资源idpathtruestring

响应状态:

状态码说明schema
200OKResourceComment
401Unauthorized
403Forbidden
404Not Found

响应参数:

参数名称参数说明类型schema
addTime创建时间string
contentstring
emailstring
foreignIdinteger(int32)integer(int32)
idinteger(int32)integer(int32)
parentIdinteger(int32)integer(int32)
profilestring
resourceIdinteger(int32)integer(int32)
userIdinteger(int32)integer(int32)
usernamestring

响应示例:

[
    {
        "addTime": "",
        "content": "",
        "email": "",
        "foreignId": 0,
        "id": 0,
        "parentId": 0,
        "profile": "",
        "resourceId": 0,
        "userId": 0,
        "username": ""
    }
]

后台分类管理接口

删除文章分类​

接口地址:/articleClass/DeleteArticleClass/{id}

请求方式:GET

请求数据类型:application/x-www-form-urlencoded

响应数据类型:*/*

接口描述:

请求参数:

参数名称参数说明请求类型是否必须数据类型schema
ididpathtruestring

响应状态:

状态码说明schema
200OK
401Unauthorized
403Forbidden
404Not Found

响应参数:

暂无

响应示例:


获取文章分类列表(分页)​

接口地址:/articleClass/allArticleClass/{page}/{limit}

请求方式:POST

请求数据类型:application/json

响应数据类型:*/*

接口描述:

请求参数:

参数名称参数说明请求类型是否必须数据类型schema
limit总量pathtruestring
page页数pathtruestring

响应状态:

状态码说明schema
200OKArticleClassPageVO
201Created
401Unauthorized
403Forbidden
404Not Found

响应参数:

参数名称参数说明类型schema
dataarrayArticleClass
  describesstring
  fatherinteger(int32)
  idinteger(int32)
  imgclassstring
  namestring
  numinteger(int32)
  otherNamestring
  topinteger(int32)
totalinteger(int64)integer(int64)

响应示例:

{
    "data": [
        {
            "describes": "",
            "father": 0,
            "id": 0,
            "imgclass": "",
            "name": "",
            "num": 0,
            "otherName": "",
            "top": 0
        }
    ],
    "total": 0
}

获取全部分类列表​

接口地址:/articleClass/getAllClassName

请求方式:GET

请求数据类型:application/x-www-form-urlencoded

响应数据类型:*/*

接口描述:

请求参数:

暂无

响应状态:

状态码说明schema
200OKClassNameVO
401Unauthorized
403Forbidden
404Not Found

响应参数:

参数名称参数说明类型schema
namestring

响应示例:

[
    {
        "name": ""
    }
]

根据id值查询对应的分类名称​

接口地址:/articleClass/getClassNameById/{id}

请求方式:GET

请求数据类型:application/x-www-form-urlencoded

响应数据类型:*/*

接口描述:

请求参数:

参数名称参数说明请求类型是否必须数据类型schema
ididpathtruestring

响应状态:

状态码说明schema
200OK
401Unauthorized
403Forbidden
404Not Found

响应参数:

暂无

响应示例:


新建文章分类​

接口地址:/articleClass/newArticleClass

请求方式:POST

请求数据类型:application/json

响应数据类型:*/*

接口描述:

请求参数:

参数名称参数说明请求类型是否必须数据类型schema
articleClass文章分类对象bodytruestring

响应状态:

状态码说明schema
200OK
201Created
401Unauthorized
403Forbidden
404Not Found

响应参数:

暂无

响应示例:


后台圈子分类管理接口

根据id删除圈子分类评论​

接口地址:/squareClass/DelectSquareClassById/{id}

请求方式:GET

请求数据类型:application/x-www-form-urlencoded

响应数据类型:*/*

接口描述:

请求参数:

参数名称参数说明请求类型是否必须数据类型schema
id文章idpathtruestring

响应状态:

状态码说明schema
200OK
401Unauthorized
403Forbidden
404Not Found

响应参数:

暂无

响应示例:


获取圈子分类列表(分页)​

接口地址:/squareClass/allSquareClass/{page}/{limit}

请求方式:POST

请求数据类型:application/json

响应数据类型:*/*

接口描述:

请求参数:

参数名称参数说明请求类型是否必须数据类型schema
limit总量pathtruestring
page页数pathtruestring

响应状态:

状态码说明schema
200OKSquareClassPageVO
201Created
401Unauthorized
403Forbidden
404Not Found

响应参数:

参数名称参数说明类型schema
dataarraySquareClass
  describesstring
  fatherinteger(int32)
  idinteger(int32)
  imgclassstring
  isFreeboolean
  namestring
  numinteger(int32)
  otherNamestring
  priceinteger(int32)
  topinteger(int32)
totalinteger(int64)integer(int64)

响应示例:

{
    "data": [
        {
            "describes": "",
            "father": 0,
            "id": 0,
            "imgclass": "",
            "isFree": true,
            "name": "",
            "num": 0,
            "otherName": "",
            "price": 0,
            "top": 0
        }
    ],
    "total": 0
}

获取全部分类列表​

接口地址:/squareClass/getAllClassName

请求方式:GET

请求数据类型:application/x-www-form-urlencoded

响应数据类型:*/*

接口描述:

请求参数:

暂无

响应状态:

状态码说明schema
200OKSquareClass
401Unauthorized
403Forbidden
404Not Found

响应参数:

参数名称参数说明类型schema
describesstring
fatherinteger(int32)integer(int32)
idinteger(int32)integer(int32)
imgclassstring
isFreeboolean
namestring
numinteger(int32)integer(int32)
otherNamestring
priceinteger(int32)integer(int32)
topinteger(int32)integer(int32)

响应示例:

[
    {
        "describes": "",
        "father": 0,
        "id": 0,
        "imgclass": "",
        "isFree": true,
        "name": "",
        "num": 0,
        "otherName": "",
        "price": 0,
        "top": 0
    }
]

根据id值查询对应的分类名称​

接口地址:/squareClass/getClassNameById/{id}

请求方式:GET

请求数据类型:application/x-www-form-urlencoded

响应数据类型:*/*

接口描述:

请求参数:

参数名称参数说明请求类型是否必须数据类型schema
ididpathtruestring

响应状态:

状态码说明schema
200OK
401Unauthorized
403Forbidden
404Not Found

响应参数:

暂无

响应示例:


新建分类​

接口地址:/squareClass/newSquareClass

请求方式:POST

请求数据类型:application/json

响应数据类型:*/*

接口描述:

请求示例:

{
  "describes": "",
  "father": 0,
  "id": 0,
  "imgclass": "",
  "isFree": true,
  "name": "",
  "num": 0,
  "otherName": "",
  "price": 0,
  "top": 0
}

请求参数:

参数名称参数说明请求类型是否必须数据类型schema
articleClass文章分类对象truestring
squareClasssquareClassbodytrueSquareClassSquareClass
  describesfalsestring
  fatherfalseinteger(int32)
  idfalseinteger(int32)
  imgclassfalsestring
  isFreefalseboolean
  namefalsestring
  numfalseinteger(int32)
  otherNamefalsestring
  pricefalseinteger(int32)
  topfalseinteger(int32)

响应状态:

状态码说明schema
200OK
201Created
401Unauthorized
403Forbidden
404Not Found

响应参数:

暂无

响应示例:


后台圈子管理接口

根据id修改圈子内容​

接口地址:/square/ChangeSquareById/{id}/{content}

请求方式:GET

请求数据类型:application/x-www-form-urlencoded

响应数据类型:*/*

接口描述:

请求参数:

参数名称参数说明请求类型是否必须数据类型schema
contentcontentpathtruestring
id文章idpathtruestring

响应状态:

状态码说明schema
200OK
401Unauthorized
403Forbidden
404Not Found

响应参数:

暂无

响应示例:


根据id删除圈子​

接口地址:/square/DelectSquareById/{id}

请求方式:GET

请求数据类型:application/x-www-form-urlencoded

响应数据类型:*/*

接口描述:

请求参数:

参数名称参数说明请求类型是否必须数据类型schema
id文章idpathtruestring

响应状态:

状态码说明schema
200OK
401Unauthorized
403Forbidden
404Not Found

响应参数:

暂无

响应示例:


获取全部圈子用户​

接口地址:/square/GetAllSquareUser

请求方式:GET

请求数据类型:application/x-www-form-urlencoded

响应数据类型:*/*

接口描述:

请求参数:

暂无

响应状态:

状态码说明schema
200OKUser
401Unauthorized
403Forbidden
404Not Found

响应参数:

参数名称参数说明类型schema
createdstring(date-time)string(date-time)
emailstring
genderstring
integralinteger(int32)integer(int32)
introstring
lastLoginstring(date-time)string(date-time)
namestring
passwordstring
profilestring
rolestring
statusinteger(int32)integer(int32)
userAgeinteger(int32)integer(int32)
userIdinteger(int32)integer(int32)
usernamestring
vipDisableTipboolean
vipExpireDatestring(date-time)string(date-time)
vipValidDatestring(date-time)string(date-time)

响应示例:

[
    {
        "created": "",
        "email": "",
        "gender": "",
        "integral": 0,
        "intro": "",
        "lastLogin": "",
        "name": "",
        "password": "",
        "profile": "",
        "role": "",
        "status": 0,
        "userAge": 0,
        "userId": 0,
        "username": "",
        "vipDisableTip": true,
        "vipExpireDate": "",
        "vipValidDate": ""
    }
]

根据别名获取全部圈子(分页)​

接口地址:/square/getAllSquare/{otherName}/{page}/{limit}

请求方式:GET

请求数据类型:application/x-www-form-urlencoded

响应数据类型:*/*

接口描述:

请求参数:

参数名称参数说明请求类型是否必须数据类型schema
limitlimitpathtrueinteger(int32)
otherNameotherNamepathtruestring
pagepagepathtrueinteger(int32)

响应状态:

状态码说明schema
200OKSquarePageVO
401Unauthorized
403Forbidden
404Not Found

响应参数:

参数名称参数说明类型schema
dataarraySquareVO
  addTime创建时间string
  authorstring
  authorImgstring
  commentDisabledstring
  commentNuminteger(int32)
  contentstring
  copyfromstring
  createTime生成时间string
  deletedinteger(int32)
  hitsinteger(int32)
  httpUrlstring
  idinteger(int32)
  inputerstring
  iseliteinteger(int32)
  keywordstring
  lastPost最后评论时间string
  loveNuminteger(int32)
  mediastring
  ontopinteger(int32)
  postNuminteger(int32)
  sortClassstring
  sortNamestring
  titlestring
  titleColorstring
  titlefontSizestring
  titlefontTypeinteger(int32)
  typeinteger(int32)
  updateTime更新时间string
  useridinteger(int32)
pagesinteger(int64)integer(int64)
totalinteger(int64)integer(int64)

响应示例:

{
    "data": [
        {
            "addTime": "",
            "author": "",
            "authorImg": "",
            "commentDisabled": "",
            "commentNum": 0,
            "content": "",
            "copyfrom": "",
            "createTime": "",
            "deleted": 0,
            "hits": 0,
            "httpUrl": "",
            "id": 0,
            "inputer": "",
            "iselite": 0,
            "keyword": "",
            "lastPost": "",
            "loveNum": 0,
            "media": "",
            "ontop": 0,
            "postNum": 0,
            "sortClass": "",
            "sortName": "",
            "title": "",
            "titleColor": "",
            "titlefontSize": "",
            "titlefontType": 0,
            "type": 0,
            "updateTime": "",
            "userid": 0
        }
    ],
    "pages": 0,
    "total": 0
}

后台圈子评论管理接口

根据id修改圈子内容评论​

接口地址:/squareComment/ChangeSquareById/{id}/{content}

请求方式:GET

请求数据类型:application/x-www-form-urlencoded

响应数据类型:*/*

接口描述:

请求参数:

参数名称参数说明请求类型是否必须数据类型schema
contentcontentpathtruestring
id文章idpathtruestring

响应状态:

状态码说明schema
200OK
401Unauthorized
403Forbidden
404Not Found

响应参数:

暂无

响应示例:


根据id删除圈子评论​

接口地址:/squareComment/DelectSquareById/{id}

请求方式:GET

请求数据类型:application/x-www-form-urlencoded

响应数据类型:*/*

接口描述:

请求参数:

参数名称参数说明请求类型是否必须数据类型schema
id文章idpathtruestring

响应状态:

状态码说明schema
200OK
401Unauthorized
403Forbidden
404Not Found

响应参数:

暂无

响应示例:


获取全部圈子评论(分页)​

接口地址:/squareComment/getAllSquare/{page}/{limit}

请求方式:GET

请求数据类型:application/x-www-form-urlencoded

响应数据类型:*/*

接口描述:

请求参数:

参数名称参数说明请求类型是否必须数据类型schema
limitlimitpathtrueinteger(int32)
otherNameotherNametruestring
pagepagepathtrueinteger(int32)

响应状态:

状态码说明schema
200OKSquareComment
401Unauthorized
403Forbidden
404Not Found

响应参数:

参数名称参数说明类型schema
addTime创建时间string
contentstring
idinteger(int32)integer(int32)
loveNuminteger(int32)integer(int32)
parentIdinteger(int32)integer(int32)
postIdinteger(int32)integer(int32)
profilestring
responderstring
responderIdinteger(int32)integer(int32)
reviewersstring
reviewersIdinteger(int32)integer(int32)
statusinteger(int32)integer(int32)
toUserIdinteger(int32)integer(int32)
typeinteger(int32)integer(int32)
userIdinteger(int32)integer(int32)

响应示例:

[
    {
        "addTime": "",
        "content": "",
        "id": 0,
        "loveNum": 0,
        "parentId": 0,
        "postId": 0,
        "profile": "",
        "responder": "",
        "responderId": 0,
        "reviewers": "",
        "reviewersId": 0,
        "status": 0,
        "toUserId": 0,
        "type": 0,
        "userId": 0
    }
]

后台文章管理接口

根据id删除文章​

接口地址:/article/DelectArticleById/{id}

请求方式:GET

请求数据类型:application/x-www-form-urlencoded

响应数据类型:*/*

接口描述:

请求参数:

参数名称参数说明请求类型是否必须数据类型schema
id文章idpathtruestring

响应状态:

状态码说明schema
200OK
401Unauthorized
403Forbidden
404Not Found

响应参数:

暂无

响应示例:


根据id修改文章​

接口地址:/article/ReviseArticleById/{id}

请求方式:POST

请求数据类型:application/json

响应数据类型:*/*

接口描述:

请求示例:

{
  "addTime": "",
  "articleStatus": 0,
  "author": "",
  "commentDisabled": "",
  "content": "",
  "copyfrom": "",
  "createTime": "",
  "deleted": 0,
  "filePath": "",
  "fullTitle": "",
  "hits": 0,
  "htmlPath": "",
  "httpUrl": "",
  "id": 0,
  "inputer": "",
  "intro": "",
  "iselite": 0,
  "keyword": "",
  "lastPost": "",
  "loveNum": 0,
  "ontop": 0,
  "ownerRemark": "",
  "ownerTag": 0,
  "postNum": 0,
  "sortClass": "",
  "status": "",
  "subhead": "",
  "tempPath": "",
  "thumb": "",
  "title": "",
  "titleColor": "",
  "titlefontSize": "",
  "titlefontType": 0,
  "updateTime": ""
}

请求参数:

参数名称参数说明请求类型是否必须数据类型schema
articlearticlebodytrueArticleArticle
  addTime创建时间falsestring
  articleStatusfalseinteger(int32)
  authorfalsestring
  commentDisabledfalsestring
  contentfalsestring
  copyfromfalsestring
  createTime生成时间falsestring
  deletedfalseinteger(int32)
  filePathfalsestring
  fullTitlefalsestring
  hitsfalseinteger(int32)
  htmlPathfalsestring
  httpUrlfalsestring
  idfalseinteger(int32)
  inputerfalsestring
  introfalsestring
  iselitefalseinteger(int32)
  keywordfalsestring
  lastPost最后评论时间falsestring
  loveNumfalseinteger(int32)
  ontopfalseinteger(int32)
  ownerRemarkfalsestring
  ownerTagfalseinteger(int32)
  postNumfalseinteger(int32)
  sortClassfalsestring
  statusfalsestring
  subheadfalsestring
  tempPathfalsestring
  thumbfalsestring
  titlefalsestring
  titleColorfalsestring
  titlefontSizefalsestring
  titlefontTypefalseinteger(int32)
  updateTime更新时间falsestring
id文章idtruestring

响应状态:

状态码说明schema
200OK
201Created
401Unauthorized
403Forbidden
404Not Found

响应参数:

暂无

响应示例:


新增文章(修改)​

接口地址:/article/create

请求方式:POST

请求数据类型:application/json

响应数据类型:*/*

接口描述:

请求参数:

参数名称参数说明请求类型是否必须数据类型schema
article文章bodytruestring

响应状态:

状态码说明schema
200OK
201Created
401Unauthorized
403Forbidden
404Not Found

响应参数:

暂无

响应示例:


获取全部文章(分页)​

接口地址:/article/getAllArticle/{page}/{limit}

请求方式:GET

请求数据类型:application/x-www-form-urlencoded

响应数据类型:*/*

接口描述:

请求参数:

参数名称参数说明请求类型是否必须数据类型schema
limit总量pathtruestring
page页数pathtruestring

响应状态:

状态码说明schema
200OKArticlePageVO
401Unauthorized
403Forbidden
404Not Found

响应参数:

参数名称参数说明类型schema
dataarrayArticleVO
  addTimestring(date-time)
  authorstring
  classNamestring
  commentNuminteger(int32)
  createTimestring(date-time)
  hitsinteger(int32)
  idinteger(int32)
  ownerTaginteger(int32)
  postNuminteger(int32)
  profilestring
  sortClassstring
  statusstring
  thumbstring
  titlestring
pagesinteger(int64)integer(int64)
totalinteger(int64)integer(int64)

响应示例:

{
    "data": [
        {
            "addTime": "",
            "author": "",
            "className": "",
            "commentNum": 0,
            "createTime": "",
            "hits": 0,
            "id": 0,
            "ownerTag": 0,
            "postNum": 0,
            "profile": "",
            "sortClass": "",
            "status": "",
            "thumb": "",
            "title": ""
        }
    ],
    "pages": 0,
    "total": 0
}

根据id获取文章​

接口地址:/article/getArticleById/{id}

请求方式:GET

请求数据类型:application/x-www-form-urlencoded

响应数据类型:*/*

接口描述:

请求参数:

参数名称参数说明请求类型是否必须数据类型schema
id文章idpathtruestring

响应状态:

状态码说明schema
200OKArticle
401Unauthorized
403Forbidden
404Not Found

响应参数:

参数名称参数说明类型schema
addTime创建时间string
articleStatusinteger(int32)integer(int32)
authorstring
commentDisabledstring
contentstring
copyfromstring
createTime生成时间string
deletedinteger(int32)integer(int32)
filePathstring
fullTitlestring
hitsinteger(int32)integer(int32)
htmlPathstring
httpUrlstring
idinteger(int32)integer(int32)
inputerstring
introstring
iseliteinteger(int32)integer(int32)
keywordstring
lastPost最后评论时间string
loveNuminteger(int32)integer(int32)
ontopinteger(int32)integer(int32)
ownerRemarkstring
ownerTaginteger(int32)integer(int32)
postNuminteger(int32)integer(int32)
sortClassstring
statusstring
subheadstring
tempPathstring
thumbstring
titlestring
titleColorstring
titlefontSizestring
titlefontTypeinteger(int32)integer(int32)
updateTime更新时间string

响应示例:

{
    "addTime": "",
    "articleStatus": 0,
    "author": "",
    "commentDisabled": "",
    "content": "",
    "copyfrom": "",
    "createTime": "",
    "deleted": 0,
    "filePath": "",
    "fullTitle": "",
    "hits": 0,
    "htmlPath": "",
    "httpUrl": "",
    "id": 0,
    "inputer": "",
    "intro": "",
    "iselite": 0,
    "keyword": "",
    "lastPost": "",
    "loveNum": 0,
    "ontop": 0,
    "ownerRemark": "",
    "ownerTag": 0,
    "postNum": 0,
    "sortClass": "",
    "status": "",
    "subhead": "",
    "tempPath": "",
    "thumb": "",
    "title": "",
    "titleColor": "",
    "titlefontSize": "",
    "titlefontType": 0,
    "updateTime": ""
}

后台设置接口

获取全部轮播图​

接口地址:/Sitting/getAllDispositionCarousel

请求方式:GET

请求数据类型:application/x-www-form-urlencoded

响应数据类型:*/*

接口描述:

请求参数:

参数名称参数说明请求类型是否必须数据类型schema
setting设置truestring

响应状态:

状态码说明schema
200OKDispositionCarousel
401Unauthorized
403Forbidden
404Not Found

响应参数:

参数名称参数说明类型schema
buttonstring
idinteger(int32)integer(int32)
imgstring
introducestring
titlestring

响应示例:

[
    {
        "button": "",
        "id": 0,
        "img": "",
        "introduce": "",
        "title": ""
    }
]

获取oss配置​

接口地址:/Sitting/getCosSetting

请求方式:GET

请求数据类型:application/x-www-form-urlencoded

响应数据类型:*/*

接口描述:

请求参数:

暂无

响应状态:

状态码说明schema
200OKSetting
401Unauthorized
403Forbidden
404Not Found

响应参数:

参数名称参数说明类型schema
banquanstring
beianstring
comment_showboolean
cosBucketNamestring
cosClientConfigstring
cosIntagestring
cosSecretIdstring
cosSecretKeystring
idinteger(int32)integer(int32)
imageFormatboolean
isCosboolean
sitLogostring
sitTitlestring

响应示例:

{
    "banquan": "",
    "beian": "",
    "comment_show": true,
    "cosBucketName": "",
    "cosClientConfig": "",
    "cosIntage": "",
    "cosSecretId": "",
    "cosSecretKey": "",
    "id": 0,
    "imageFormat": true,
    "isCos": true,
    "sitLogo": "",
    "sitTitle": ""
}

修改设置​

接口地址:/Sitting/setSetting

请求方式:POST

请求数据类型:application/json

响应数据类型:*/*

接口描述:

请求参数:

参数名称参数说明请求类型是否必须数据类型schema
setting设置bodytruestring

响应状态:

状态码说明schema
200OK
201Created
401Unauthorized
403Forbidden
404Not Found

响应参数:

暂无

响应示例:


修改设置​

接口地址:/Sitting/setSettingCos

请求方式:POST

请求数据类型:application/json

响应数据类型:*/*

接口描述:

请求参数:

参数名称参数说明请求类型是否必须数据类型schema
setting设置bodytruestring

响应状态:

状态码说明schema
200OK
201Created
401Unauthorized
403Forbidden
404Not Found

响应参数:

暂无

响应示例:


后台评论管理接口

增加评论​

接口地址:/ArticleComment/addArticleComment

请求方式:POST

请求数据类型:application/json

响应数据类型:*/*

接口描述:

请求参数:

参数名称参数说明请求类型是否必须数据类型schema
articleComment文章分类对象bodytruestring

响应状态:

状态码说明schema
200OK
201Created
401Unauthorized
403Forbidden
404Not Found

响应参数:

暂无

响应示例:


查看文章对应评论数​

接口地址:/ArticleComment/getArticleCommentnum/{articleId}

请求方式:GET

请求数据类型:application/x-www-form-urlencoded

响应数据类型:*/*

接口描述:

请求参数:

参数名称参数说明请求类型是否必须数据类型schema
articleId文章idpathtruestring

响应状态:

状态码说明schema
200OK
401Unauthorized
403Forbidden
404Not Found

响应参数:

暂无

响应示例:


根据文章id查询对应的评论​

接口地址:/ArticleComment/getallArticleComment/{articleId}

请求方式:GET

请求数据类型:application/x-www-form-urlencoded

响应数据类型:*/*

接口描述:

请求参数:

参数名称参数说明请求类型是否必须数据类型schema
articleId文章idpathtruestring

响应状态:

状态码说明schema
200OKArticleComment
401Unauthorized
403Forbidden
404Not Found

响应参数:

参数名称参数说明类型schema
addTime创建时间string
articleIdinteger(int32)integer(int32)
contentstring
emailstring
foreignIdinteger(int32)integer(int32)
idinteger(int32)integer(int32)
parentIdinteger(int32)integer(int32)
profilestring
userIdinteger(int32)integer(int32)
usernamestring

响应示例:

[
    {
        "addTime": "",
        "articleId": 0,
        "content": "",
        "email": "",
        "foreignId": 0,
        "id": 0,
        "parentId": 0,
        "profile": "",
        "userId": 0,
        "username": ""
    }
]

获取全部评论​

接口地址:/ArticleComment/getallArticleComments

请求方式:GET

请求数据类型:application/x-www-form-urlencoded

响应数据类型:*/*

接口描述:

请求参数:

暂无

响应状态:

状态码说明schema
200OKArticleComment
401Unauthorized
403Forbidden
404Not Found

响应参数:

参数名称参数说明类型schema
addTime创建时间string
articleIdinteger(int32)integer(int32)
contentstring
emailstring
foreignIdinteger(int32)integer(int32)
idinteger(int32)integer(int32)
parentIdinteger(int32)integer(int32)
profilestring
userIdinteger(int32)integer(int32)
usernamestring

响应示例:

[
    {
        "addTime": "",
        "articleId": 0,
        "content": "",
        "email": "",
        "foreignId": 0,
        "id": 0,
        "parentId": 0,
        "profile": "",
        "userId": 0,
        "username": ""
    }
]

后台资源分类管理接口

删除资源分类​

接口地址:/ResourceClass/DeleteResourceClass/{id}

请求方式:GET

请求数据类型:application/x-www-form-urlencoded

响应数据类型:*/*

接口描述:

请求参数:

参数名称参数说明请求类型是否必须数据类型schema
ididpathtruestring

响应状态:

状态码说明schema
200OK
401Unauthorized
403Forbidden
404Not Found

响应参数:

暂无

响应示例:


获取资源分类列表(分页)​

接口地址:/ResourceClass/allResourceClass/{page}/{limit}

请求方式:POST

请求数据类型:application/json

响应数据类型:*/*

接口描述:

请求参数:

参数名称参数说明请求类型是否必须数据类型schema
limit总量pathtruestring
page页数pathtruestring

响应状态:

状态码说明schema
200OKResourceClassPageVO
201Created
401Unauthorized
403Forbidden
404Not Found

响应参数:

参数名称参数说明类型schema
dataarrayResourceClass
  describesstring
  fatherinteger(int32)
  idinteger(int32)
  imgclassstring
  namestring
  numinteger(int32)
  otherNamestring
  topinteger(int32)
totalinteger(int64)integer(int64)

响应示例:

{
    "data": [
        {
            "describes": "",
            "father": 0,
            "id": 0,
            "imgclass": "",
            "name": "",
            "num": 0,
            "otherName": "",
            "top": 0
        }
    ],
    "total": 0
}

获取全部分类列表​

接口地址:/ResourceClass/getAllClassName

请求方式:GET

请求数据类型:application/x-www-form-urlencoded

响应数据类型:*/*

接口描述:

请求参数:

暂无

响应状态:

状态码说明schema
200OKClassNameVO
401Unauthorized
403Forbidden
404Not Found

响应参数:

参数名称参数说明类型schema
namestring

响应示例:

[
    {
        "name": ""
    }
]

根据id值查询对应的分类名称​

接口地址:/ResourceClass/getClassNameById/{id}

请求方式:GET

请求数据类型:application/x-www-form-urlencoded

响应数据类型:*/*

接口描述:

请求参数:

参数名称参数说明请求类型是否必须数据类型schema
ididpathtruestring

响应状态:

状态码说明schema
200OK
401Unauthorized
403Forbidden
404Not Found

响应参数:

暂无

响应示例:


新建资源分类​

接口地址:/ResourceClass/newResourceClass

请求方式:POST

请求数据类型:application/json

响应数据类型:*/*

接口描述:

请求参数:

参数名称参数说明请求类型是否必须数据类型schema
resourceClass文章分类对象bodytruestring

响应状态:

状态码说明schema
200OK
201Created
401Unauthorized
403Forbidden
404Not Found

响应参数:

暂无

响应示例:


后台资源管理接口

根据id删除资源​

接口地址:/resource/DelectResourceById/{id}

请求方式:GET

请求数据类型:application/x-www-form-urlencoded

响应数据类型:*/*

接口描述:

请求参数:

参数名称参数说明请求类型是否必须数据类型schema
id资源idpathtruestring

响应状态:

状态码说明schema
200OK
401Unauthorized
403Forbidden
404Not Found

响应参数:

暂无

响应示例:


新增资源(修改)​

接口地址:/resource/create

请求方式:POST

请求数据类型:application/json

响应数据类型:*/*

接口描述:

请求参数:

参数名称参数说明请求类型是否必须数据类型schema
resource资源bodytruestring

响应状态:

状态码说明schema
200OK
201Created
401Unauthorized
403Forbidden
404Not Found

响应参数:

暂无

响应示例:


获取全部资源(分页)​

接口地址:/resource/getAllResource/{page}/{limit}

请求方式:GET

请求数据类型:application/x-www-form-urlencoded

响应数据类型:*/*

接口描述:

请求参数:

参数名称参数说明请求类型是否必须数据类型schema
limit总量pathtruestring
page页数pathtruestring

响应状态:

状态码说明schema
200OKResourcePageVO
401Unauthorized
403Forbidden
404Not Found

响应参数:

参数名称参数说明类型schema
dataarrayResourceVO
  addTimestring(date-time)
  authorstring
  authorThumbstring
  createTimestring(date-time)
  hitsinteger(int32)
  idinteger(int32)
  introstring
  ownerTaginteger(int32)
  pricestring
  profilestring
  sortClassstring
  statusstring
  subheadstring
  thumbstring
  titlestring
totalinteger(int64)integer(int64)

响应示例:

{
    "data": [
        {
            "addTime": "",
            "author": "",
            "authorThumb": "",
            "createTime": "",
            "hits": 0,
            "id": 0,
            "intro": "",
            "ownerTag": 0,
            "price": "",
            "profile": "",
            "sortClass": "",
            "status": "",
            "subhead": "",
            "thumb": "",
            "title": ""
        }
    ],
    "total": 0
}

根据id获取资源​

接口地址:/resource/getResourceById/{id}

请求方式:GET

请求数据类型:application/x-www-form-urlencoded

响应数据类型:*/*

接口描述:

请求参数:

参数名称参数说明请求类型是否必须数据类型schema
id资源idpathtruestring

响应状态:

状态码说明schema
200OKResource
401Unauthorized
403Forbidden
404Not Found

响应参数:

参数名称参数说明类型schema
addTime创建时间string
articleStatusinteger(int32)integer(int32)
authorstring
carouselstring
commentDisabledstring
contentstring
copyfromstring
createTime生成时间string
deletedinteger(int32)integer(int32)
filePathstring
fullTitlestring
hitsinteger(int32)integer(int32)
htmlPathstring
httpUrlstring
idinteger(int32)integer(int32)
inputerstring
introstring
isFreeboolean
iseliteinteger(int32)integer(int32)
keywordstring
lastPost最后评论时间string
loveNuminteger(int32)integer(int32)
ontopinteger(int32)integer(int32)
ownerRemarkstring
ownerTaginteger(int32)integer(int32)
postNuminteger(int32)integer(int32)
pricestring
resAddressstring
resPasswordstring
sortClassstring
statusstring
subheadstring
tempPathstring
thumbstring
titlestring
titleColorstring
titlefontSizestring
titlefontTypeinteger(int32)integer(int32)
updateTime更新时间string

响应示例:

{
    "addTime": "",
    "articleStatus": 0,
    "author": "",
    "carousel": "",
    "commentDisabled": "",
    "content": "",
    "copyfrom": "",
    "createTime": "",
    "deleted": 0,
    "filePath": "",
    "fullTitle": "",
    "hits": 0,
    "htmlPath": "",
    "httpUrl": "",
    "id": 0,
    "inputer": "",
    "intro": "",
    "isFree": true,
    "iselite": 0,
    "keyword": "",
    "lastPost": "",
    "loveNum": 0,
    "ontop": 0,
    "ownerRemark": "",
    "ownerTag": 0,
    "postNum": 0,
    "price": "",
    "resAddress": "",
    "resPassword": "",
    "sortClass": "",
    "status": "",
    "subhead": "",
    "tempPath": "",
    "thumb": "",
    "title": "",
    "titleColor": "",
    "titlefontSize": "",
    "titlefontType": 0,
    "updateTime": ""
}

后台资源评论管理接口

获取全部评论​

接口地址:/ResourceComment/getAllResourceComments

请求方式:GET

请求数据类型:application/x-www-form-urlencoded

响应数据类型:*/*

接口描述:

请求参数:

暂无

响应状态:

状态码说明schema
200OKResourceComment
401Unauthorized
403Forbidden
404Not Found

响应参数:

参数名称参数说明类型schema
addTime创建时间string
contentstring
emailstring
foreignIdinteger(int32)integer(int32)
idinteger(int32)integer(int32)
parentIdinteger(int32)integer(int32)
profilestring
resourceIdinteger(int32)integer(int32)
userIdinteger(int32)integer(int32)
usernamestring

响应示例:

[
    {
        "addTime": "",
        "content": "",
        "email": "",
        "foreignId": 0,
        "id": 0,
        "parentId": 0,
        "profile": "",
        "resourceId": 0,
        "userId": 0,
        "username": ""
    }
]

图片工具类Api

上传图片(添加文字水印)​

接口地址:/ImageApi/addwatermarkimageUpload/{title}/{content}

请求方式:POST

请求数据类型:multipart/form-data

响应数据类型:*/*

接口描述:

请求参数:

参数名称参数说明请求类型是否必须数据类型schema
content内容pathtruestring
editormd-image-file图片FormateformDatatruestring
title标题pathtruestring

响应状态:

状态码说明schema
200OK
201Created
401Unauthorized
403Forbidden
404Not Found

响应参数:

暂无

响应示例:


上传图片​

接口地址:/ImageApi/updateimage

请求方式:POST

请求数据类型:multipart/form-data

响应数据类型:*/*

接口描述:

请求参数:

参数名称参数说明请求类型是否必须数据类型schema
editormd-image-file图片FormateformDatatruestring

响应状态:

状态码说明schema
200OK
201Created
401Unauthorized
403Forbidden
404Not Found

响应参数:

暂无

响应示例:


微信支付API

用户取消订单​

接口地址:/Pay-api/wx-pay/cancel/{orderNo}

请求方式:POST

请求数据类型:application/json

响应数据类型:*/*

接口描述:

请求参数:

参数名称参数说明请求类型是否必须数据类型schema
orderNoorderNopathtruestring

响应状态:

状态码说明schema
200OKR
201Created
401Unauthorized
403Forbidden
404Not Found

响应参数:

参数名称参数说明类型schema
codeinteger(int32)integer(int32)
dataobject
messagestring

响应示例:

{
    "code": 0,
    "data": {},
    "message": ""
}

下载账单​

接口地址:/Pay-api/wx-pay/downloadbill/{billDate}/{type}

请求方式:GET

请求数据类型:application/x-www-form-urlencoded

响应数据类型:*/*

接口描述:

请求参数:

参数名称参数说明请求类型是否必须数据类型schema
billDatebillDatepathtruestring
typetypepathtruestring

响应状态:

状态码说明schema
200OKR
401Unauthorized
403Forbidden
404Not Found

响应参数:

参数名称参数说明类型schema
codeinteger(int32)integer(int32)
dataobject
messagestring

响应示例:

{
    "code": 0,
    "data": {},
    "message": ""
}

调用统一下单API，生成支付二维码（登陆）​

接口地址:/Pay-api/wx-pay/login-native/{productId}/{userid}

请求方式:POST

请求数据类型:application/json

响应数据类型:*/*

接口描述:

请求参数:

参数名称参数说明请求类型是否必须数据类型schema
productId资源idpathtruestring
userid用户idpathtruestring

响应状态:

状态码说明schema
200OKR
201Created
401Unauthorized
403Forbidden
404Not Found

响应参数:

参数名称参数说明类型schema
codeinteger(int32)integer(int32)
dataobject
messagestring

响应示例:

{
    "code": 0,
    "data": {},
    "message": ""
}

支付通知​

接口地址:/Pay-api/wx-pay/native/notify

请求方式:POST

请求数据类型:application/json

响应数据类型:*/*

接口描述:

请求参数:

暂无

响应状态:

状态码说明schema
200OK
201Created
401Unauthorized
403Forbidden
404Not Found

响应参数:

暂无

响应示例:


查询退款：测试用​

接口地址:/Pay-api/wx-pay/query-refund/{refundNo}

请求方式:GET

请求数据类型:application/x-www-form-urlencoded

响应数据类型:*/*

接口描述:

请求参数:

参数名称参数说明请求类型是否必须数据类型schema
refundNorefundNopathtruestring

响应状态:

状态码说明schema
200OKR
401Unauthorized
403Forbidden
404Not Found

响应参数:

参数名称参数说明类型schema
codeinteger(int32)integer(int32)
dataobject
messagestring

响应示例:

{
    "code": 0,
    "data": {},
    "message": ""
}

查询订单：测试订单状态用​

接口地址:/Pay-api/wx-pay/query/{orderNo}

请求方式:GET

请求数据类型:application/x-www-form-urlencoded

响应数据类型:*/*

接口描述:

请求参数:

参数名称参数说明请求类型是否必须数据类型schema
orderNoorderNopathtruestring

响应状态:

状态码说明schema
200OKR
401Unauthorized
403Forbidden
404Not Found

响应参数:

参数名称参数说明类型schema
codeinteger(int32)integer(int32)
dataobject
messagestring

响应示例:

{
    "code": 0,
    "data": {},
    "message": ""
}

获取账单url：测试用​

接口地址:/Pay-api/wx-pay/querybill/{billDate}/{type}

请求方式:GET

请求数据类型:application/x-www-form-urlencoded

响应数据类型:*/*

接口描述:

请求参数:

参数名称参数说明请求类型是否必须数据类型schema
billDatebillDatepathtruestring
typetypepathtruestring

响应状态:

状态码说明schema
200OKR
401Unauthorized
403Forbidden
404Not Found

响应参数:

参数名称参数说明类型schema
codeinteger(int32)integer(int32)
dataobject
messagestring

响应示例:

{
    "code": 0,
    "data": {},
    "message": ""
}

退款结果通知​

接口地址:/Pay-api/wx-pay/refunds/notify

请求方式:POST

请求数据类型:application/json

响应数据类型:*/*

接口描述:

请求参数:

暂无

响应状态:

状态码说明schema
200OK
201Created
401Unauthorized
403Forbidden
404Not Found

响应参数:

暂无

响应示例:


申请退款​

接口地址:/Pay-api/wx-pay/refunds/{orderNo}/{reason}

请求方式:POST

请求数据类型:application/json

响应数据类型:*/*

接口描述:

请求参数:

参数名称参数说明请求类型是否必须数据类型schema
orderNoorderNopathtruestring
reasonreasonpathtruestring

响应状态:

状态码说明schema
200OKR
201Created
401Unauthorized
403Forbidden
404Not Found

响应参数:

参数名称参数说明类型schema
codeinteger(int32)integer(int32)
dataobject
messagestring

响应示例:

{
    "code": 0,
    "data": {},
    "message": ""
}

调用统一下单API，生成支付二维码（临时）​

接口地址:/Pay-api/wx-pay/temp-native/{resourceId}

请求方式:POST

请求数据类型:application/json

响应数据类型:*/*

接口描述:

请求参数:

参数名称参数说明请求类型是否必须数据类型schema
resourceId商品idpathtruestring

响应状态:

状态码说明schema
200OKR
201Created
401Unauthorized
403Forbidden
404Not Found

响应参数:

参数名称参数说明类型schema
codeinteger(int32)integer(int32)
dataobject
messagestring

响应示例:

{
    "code": 0,
    "data": {},
    "message": ""
}

调用统一下单API，生成支付二维码（调试）​

接口地址:/Pay-api/wx-pay/test-native/{productId}

请求方式:POST

请求数据类型:application/json

响应数据类型:*/*

接口描述:

请求参数:

参数名称参数说明请求类型是否必须数据类型schema
productId商品idpathtruestring

响应状态:

状态码说明schema
200OKR
201Created
401Unauthorized
403Forbidden
404Not Found

响应参数:

参数名称参数说明类型schema
codeinteger(int32)integer(int32)
dataobject
messagestring

响应示例:

{
    "code": 0,
    "data": {},
    "message": ""
}

调用统一下单API，生成支付二维码（Vip）​

接口地址:/Pay-api/wx-pay/vip-native/{price}/{userid}/{payid}

请求方式:POST

请求数据类型:application/json

响应数据类型:*/*

接口描述:

请求参数:

参数名称参数说明请求类型是否必须数据类型schema
payid支付idpathtruestring
price价格pathtruestring
userid用户idpathtruestring

响应状态:

状态码说明schema
200OKR
201Created
401Unauthorized
403Forbidden
404Not Found

响应参数:

参数名称参数说明类型schema
codeinteger(int32)integer(int32)
dataobject
messagestring

响应示例:

{
    "code": 0,
    "data": {},
    "message": ""
}

调用统一下单API，生成支付二维码（VipIntegral）​

接口地址:/Pay-api/wx-pay/vipIntegral-native/{price}/{userid}

请求方式:POST

请求数据类型:application/json

响应数据类型:*/*

接口描述:

请求参数:

参数名称参数说明请求类型是否必须数据类型schema
price价格pathtruestring
userid用户idpathtruestring

响应状态:

状态码说明schema
200OKR
201Created
401Unauthorized
403Forbidden
404Not Found

响应参数:

参数名称参数说明类型schema
codeinteger(int32)integer(int32)
dataobject
messagestring

响应示例:

{
    "code": 0,
    "data": {},
    "message": ""
}

支付宝支付API

支付宝异步回调​

接口地址:/Pay-api/ali-pay/alipay/notify

请求方式:POST

请求数据类型:application/json

响应数据类型:*/*

接口描述:

请求参数:

暂无

响应状态:

状态码说明schema
200OK
201Created
401Unauthorized
403Forbidden
404Not Found

响应参数:

暂无

响应示例:


支付宝同步回调​

接口地址:/Pay-api/ali-pay/alipay/return

请求方式:POST

请求数据类型:application/json

响应数据类型:*/*

接口描述:

请求参数:

暂无

响应状态:

状态码说明schema
200OK
201Created
401Unauthorized
403Forbidden
404Not Found

响应参数:

暂无

响应示例:


用户取消订单​

接口地址:/Pay-api/ali-pay/cancel/{orderNo}

请求方式:POST

请求数据类型:application/json

响应数据类型:*/*

接口描述:

请求参数:

参数名称参数说明请求类型是否必须数据类型schema
orderNo订单编号pathtruestring

响应状态:

状态码说明schema
200OKR
201Created
401Unauthorized
403Forbidden
404Not Found

响应参数:

参数名称参数说明类型schema
codeinteger(int32)integer(int32)
dataobject
messagestring

响应示例:

{
    "code": 0,
    "data": {},
    "message": ""
}

调用统一下单API，生成支付二维码（登陆）​

接口地址:/Pay-api/ali-pay/login-ftof/{resourceId}/{userid}

请求方式:POST

请求数据类型:application/json

响应数据类型:*/*

接口描述:

请求参数:

参数名称参数说明请求类型是否必须数据类型schema
resourceId商品idpathtruestring
userid用户idpathtruestring

响应状态:

状态码说明schema
200OKR
201Created
401Unauthorized
403Forbidden
404Not Found

响应参数:

参数名称参数说明类型schema
codeinteger(int32)integer(int32)
dataobject
messagestring

响应示例:

{
    "code": 0,
    "data": {},
    "message": ""
}

申请退款​

接口地址:/Pay-api/ali-pay/refunds/{orderNo}/{reason}

请求方式:POST

请求数据类型:application/json

响应数据类型:*/*

接口描述:

请求参数:

参数名称参数说明请求类型是否必须数据类型schema
orderNoorderNopathtruestring
reasonreasonpathtruestring

响应状态:

状态码说明schema
200OKR
201Created
401Unauthorized
403Forbidden
404Not Found

响应参数:

参数名称参数说明类型schema
codeinteger(int32)integer(int32)
dataobject
messagestring

响应示例:

{
    "code": 0,
    "data": {},
    "message": ""
}

调用统一下单API，生成支付二维码（临时）​

接口地址:/Pay-api/ali-pay/temp-ftof/{resourceId}

请求方式:POST

请求数据类型:application/json

响应数据类型:*/*

接口描述:

请求参数:

参数名称参数说明请求类型是否必须数据类型schema
resourceId商品idpathtruestring

响应状态:

状态码说明schema
200OKR
201Created
401Unauthorized
403Forbidden
404Not Found

响应参数:

参数名称参数说明类型schema
codeinteger(int32)integer(int32)
dataobject
messagestring

响应示例:

{
    "code": 0,
    "data": {},
    "message": ""
}

调用统一下单API，生成支付二维码（测试）​

接口地址:/Pay-api/ali-pay/test-ftof/{productId}

请求方式:POST

请求数据类型:application/json

响应数据类型:*/*

接口描述:

请求参数:

参数名称参数说明请求类型是否必须数据类型schema
productId商品idpathtruestring

响应状态:

状态码说明schema
200OKR
201Created
401Unauthorized
403Forbidden
404Not Found

响应参数:

参数名称参数说明类型schema
codeinteger(int32)integer(int32)
dataobject
messagestring

响应示例:

{
    "code": 0,
    "data": {},
    "message": ""
}

调用统一下单API，生成支付二维码（vip）​

接口地址:/Pay-api/ali-pay/vip-ftof/{price}/{userid}/{payid}

请求方式:POST

请求数据类型:application/json

响应数据类型:*/*

接口描述:

请求参数:

参数名称参数说明请求类型是否必须数据类型schema
payid支付idpathtruestring
price价格pathtruestring
userid用户idpathtruestring

响应状态:

状态码说明schema
200OKR
201Created
401Unauthorized
403Forbidden
404Not Found

响应参数:

参数名称参数说明类型schema
codeinteger(int32)integer(int32)
dataobject
messagestring

响应示例:

{
    "code": 0,
    "data": {},
    "message": ""
}

调用统一下单API，生成支付二维码（vipIntegral）​

接口地址:/Pay-api/ali-pay/vipIntegral-ftof/{price}/{userid}

请求方式:POST

请求数据类型:application/json

响应数据类型:*/*

接口描述:

请求参数:

参数名称参数说明请求类型是否必须数据类型schema
price价格pathtruestring
userid用户idpathtruestring

响应状态:

状态码说明schema
200OKR
201Created
401Unauthorized
403Forbidden
404Not Found

响应参数:

参数名称参数说明类型schema
codeinteger(int32)integer(int32)
dataobject
messagestring

响应示例:

{
    "code": 0,
    "data": {},
    "message": ""
}

测试商品管理

商品列表​

接口地址:/api/product/list

请求方式:GET

请求数据类型:application/x-www-form-urlencoded

响应数据类型:*/*

接口描述:

请求参数:

暂无

响应状态:

状态码说明schema
200OKR
401Unauthorized
403Forbidden
404Not Found

响应参数:

参数名称参数说明类型schema
codeinteger(int32)integer(int32)
dataobject
messagestring

响应示例:

{
    "code": 0,
    "data": {},
    "message": ""
}

测试接口​

接口地址:/api/product/test

请求方式:GET

请求数据类型:application/x-www-form-urlencoded

响应数据类型:*/*

接口描述:

请求参数:

暂无

响应状态:

状态码说明schema
200OKR
401Unauthorized
403Forbidden
404Not Found

响应参数:

参数名称参数说明类型schema
codeinteger(int32)integer(int32)
dataobject
messagestring

响应示例:

{
    "code": 0,
    "data": {},
    "message": ""
}

测试商品订单管理

根据id查询订单列表​

接口地址:/Pay-api/order-info/PaylistById/{userId}

请求方式:GET

请求数据类型:application/x-www-form-urlencoded

响应数据类型:*/*

接口描述:

请求参数:

参数名称参数说明请求类型是否必须数据类型schema
userIduserIdpathtrueinteger(int32)

响应状态:

状态码说明schema
200OKR
401Unauthorized
403Forbidden
404Not Found

响应参数:

参数名称参数说明类型schema
codeinteger(int32)integer(int32)
dataobject
messagestring

响应示例:

{
    "code": 0,
    "data": {},
    "message": ""
}

订单列表​

接口地址:/Pay-api/order-info/list

请求方式:GET

请求数据类型:application/x-www-form-urlencoded

响应数据类型:*/*

接口描述:

请求参数:

暂无

响应状态:

状态码说明schema
200OKR
401Unauthorized
403Forbidden
404Not Found

响应参数:

参数名称参数说明类型schema
codeinteger(int32)integer(int32)
dataobject
messagestring

响应示例:

{
    "code": 0,
    "data": {},
    "message": ""
}

查询本地订单状态(userid和resourceid)​

接口地址:/Pay-api/order-info/query-order-status-Bytrue/{userid}/{resourceid}

请求方式:GET

请求数据类型:application/x-www-form-urlencoded

响应数据类型:*/*

接口描述:

请求参数:

参数名称参数说明请求类型是否必须数据类型schema
resourceidresourceidpathtruestring
useriduseridpathtruestring

响应状态:

状态码说明schema
200OKR
401Unauthorized
403Forbidden
404Not Found

响应参数:

参数名称参数说明类型schema
codeinteger(int32)integer(int32)
dataobject
messagestring

响应示例:

{
    "code": 0,
    "data": {},
    "message": ""
}

根据订单号查询本地订单状态​

接口地址:/Pay-api/order-info/query-order-status/{orderNo}

请求方式:GET

请求数据类型:application/x-www-form-urlencoded

响应数据类型:*/*

接口描述:

请求参数:

参数名称参数说明请求类型是否必须数据类型schema
orderNoorderNopathtruestring

响应状态:

状态码说明schema
200OKR
401Unauthorized
403Forbidden
404Not Found

响应参数:

参数名称参数说明类型schema
codeinteger(int32)integer(int32)
dataobject
messagestring

响应示例:

{
    "code": 0,
    "data": {},
    "message": ""
}

用户登陆验证接口

修改名称​

接口地址:/User/ChangeName/{jwt}/{name}/{userid}

请求方式:POST

请求数据类型:application/json

响应数据类型:*/*

接口描述:

请求参数:

参数名称参数说明请求类型是否必须数据类型schema
jwtjwtpathtruestring
name名称pathtruestring
userid用户idpathtruestring

响应状态:

状态码说明schema
200OKResult
201Created
401Unauthorized
403Forbidden
404Not Found

响应参数:

参数名称参数说明类型schema
codeinteger(int32)integer(int32)
dataobject
msgstring

响应示例:

{
    "code": 0,
    "data": {},
    "msg": ""
}

修改密码​

接口地址:/User/ChangePassword/{jwt}/{yuanPassWord}/{NewPassWord}/{userid}

请求方式:POST

请求数据类型:application/json

响应数据类型:*/*

接口描述:

请求参数:

参数名称参数说明请求类型是否必须数据类型schema
NewPassWord新密码pathtruestring
jwtjwtpathtruestring
userid用户idpathtruestring
yuanPassWord原密码pathtruestring

响应状态:

状态码说明schema
200OKResult
201Created
401Unauthorized
403Forbidden
404Not Found

响应参数:

参数名称参数说明类型schema
codeinteger(int32)integer(int32)
dataobject
msgstring

响应示例:

{
    "code": 0,
    "data": {},
    "msg": ""
}

修改用户信息​

接口地址:/User/ChangeUser/{jwt}

请求方式:POST

请求数据类型:application/json

响应数据类型:*/*

接口描述:

请求参数:

参数名称参数说明请求类型是否必须数据类型schema
jwtjwtpathtruestring
user用户对象bodytruestring

响应状态:

状态码说明schema
200OKResult
201Created
401Unauthorized
403Forbidden
404Not Found

响应参数:

参数名称参数说明类型schema
codeinteger(int32)integer(int32)
dataobject
msgstring

响应示例:

{
    "code": 0,
    "data": {},
    "msg": ""
}

根据用户名判断是否是管理员​

接口地址:/User/CheckAdmin/{userid}

请求方式:GET

请求数据类型:application/x-www-form-urlencoded

响应数据类型:*/*

接口描述:

请求参数:

参数名称参数说明请求类型是否必须数据类型schema
userid用户名idpathtruestring

响应状态:

状态码说明schema
200OKResult
401Unauthorized
403Forbidden
404Not Found

响应参数:

参数名称参数说明类型schema
codeinteger(int32)integer(int32)
dataobject
msgstring

响应示例:

{
    "code": 0,
    "data": {},
    "msg": ""
}

检测会员是否有效​

接口地址:/User/CheckVip/{id}

请求方式:GET

请求数据类型:application/x-www-form-urlencoded

响应数据类型:*/*

接口描述:

请求参数:

参数名称参数说明请求类型是否必须数据类型schema
ididpathtruestring

响应状态:

状态码说明schema
200OK
401Unauthorized
403Forbidden
404Not Found

响应参数:

暂无

响应示例:


注册账号​

接口地址:/User/Create

请求方式:GET

请求数据类型:application/x-www-form-urlencoded

响应数据类型:*/*

接口描述:

请求参数:

参数名称参数说明请求类型是否必须数据类型schema
Newuser用户对象truestring
createdqueryfalsestring(date-time)
emailqueryfalsestring
genderqueryfalsestring
integralqueryfalseinteger(int32)
introqueryfalsestring
lastLoginqueryfalsestring(date-time)
namequeryfalsestring
passwordqueryfalsestring
profilequeryfalsestring
rolequeryfalsestring
statusqueryfalseinteger(int32)
userAgequeryfalseinteger(int32)
userIdqueryfalseinteger(int32)
usernamequeryfalsestring
vipDisableTipqueryfalseboolean
vipExpireDatequeryfalsestring(date-time)
vipValidDatequeryfalsestring(date-time)

响应状态:

状态码说明schema
200OKResult
401Unauthorized
403Forbidden
404Not Found

响应参数:

参数名称参数说明类型schema
codeinteger(int32)integer(int32)
dataobject
msgstring

响应示例:

{
    "code": 0,
    "data": {},
    "msg": ""
}

绑定邮箱​

接口地址:/User/CreateEmail/{jwt}/{email}/{userid}

请求方式:POST

请求数据类型:application/json

响应数据类型:*/*

接口描述:

请求参数:

参数名称参数说明请求类型是否必须数据类型schema
email邮箱pathtruestring
jwtjwtpathtruestring
userid用户idpathtruestring

响应状态:

状态码说明schema
200OKResult
201Created
401Unauthorized
403Forbidden
404Not Found

响应参数:

参数名称参数说明类型schema
codeinteger(int32)integer(int32)
dataobject
msgstring

响应示例:

{
    "code": 0,
    "data": {},
    "msg": ""
}

会员充值​

接口地址:/User/CreateVip/{id}/{payid}/{order}

请求方式:GET

请求数据类型:application/x-www-form-urlencoded

响应数据类型:*/*

接口描述:

请求参数:

参数名称参数说明请求类型是否必须数据类型schema
ididpathtruestring
order订单pathtruestring
payid支付idpathtruestring

响应状态:

状态码说明schema
200OKResult
401Unauthorized
403Forbidden
404Not Found

响应参数:

参数名称参数说明类型schema
codeinteger(int32)integer(int32)
dataobject
msgstring

响应示例:

{
    "code": 0,
    "data": {},
    "msg": ""
}

根据用户id获取用户信息​

接口地址:/User/GetUserInfoByid/{id}

请求方式:GET

请求数据类型:application/x-www-form-urlencoded

响应数据类型:*/*

接口描述:

请求参数:

参数名称参数说明请求类型是否必须数据类型schema
ididpathtruestring

响应状态:

状态码说明schema
200OKUser
401Unauthorized
403Forbidden
404Not Found

响应参数:

参数名称参数说明类型schema
createdstring(date-time)string(date-time)
emailstring
genderstring
integralinteger(int32)integer(int32)
introstring
lastLoginstring(date-time)string(date-time)
namestring
passwordstring
profilestring
rolestring
statusinteger(int32)integer(int32)
userAgeinteger(int32)integer(int32)
userIdinteger(int32)integer(int32)
usernamestring
vipDisableTipboolean
vipExpireDatestring(date-time)string(date-time)
vipValidDatestring(date-time)string(date-time)

响应示例:

{
    "created": "",
    "email": "",
    "gender": "",
    "integral": 0,
    "intro": "",
    "lastLogin": "",
    "name": "",
    "password": "",
    "profile": "",
    "role": "",
    "status": 0,
    "userAge": 0,
    "userId": 0,
    "username": "",
    "vipDisableTip": true,
    "vipExpireDate": "",
    "vipValidDate": ""
}

积分充值​

接口地址:/User/UpdateIntegral/{id}/{integral}/{order}

请求方式:GET

请求数据类型:application/x-www-form-urlencoded

响应数据类型:*/*

接口描述:

请求参数:

参数名称参数说明请求类型是否必须数据类型schema
ididpathtruestring
integral积分pathtruestring
order订单pathtruestring

响应状态:

状态码说明schema
200OKResult
401Unauthorized
403Forbidden
404Not Found

响应参数:

参数名称参数说明类型schema
codeinteger(int32)integer(int32)
dataobject
msgstring

响应示例:

{
    "code": 0,
    "data": {},
    "msg": ""
}

验证Token​

接口地址:/User/checkToken

请求方式:GET

请求数据类型:application/x-www-form-urlencoded

响应数据类型:*/*

接口描述:

请求参数:

参数名称参数说明请求类型是否必须数据类型schema
requestheader里的token值truestring

响应状态:

状态码说明schema
200OK
401Unauthorized
403Forbidden
404Not Found

响应参数:

暂无

响应示例:


登陆​

接口地址:/User/login

请求方式:GET

请求数据类型:application/x-www-form-urlencoded

响应数据类型:*/*

接口描述:

请求参数:

参数名称参数说明请求类型是否必须数据类型schema
user用户对象truestring
createdqueryfalsestring(date-time)
emailqueryfalsestring
genderqueryfalsestring
integralqueryfalseinteger(int32)
introqueryfalsestring
lastLoginqueryfalsestring(date-time)
namequeryfalsestring
passwordqueryfalsestring
profilequeryfalsestring
rolequeryfalsestring
statusqueryfalseinteger(int32)
userAgequeryfalseinteger(int32)
userIdqueryfalseinteger(int32)
usernamequeryfalsestring
vipDisableTipqueryfalseboolean
vipExpireDatequeryfalsestring(date-time)
vipValidDatequeryfalsestring(date-time)

响应状态:

状态码说明schema
200OKResult
401Unauthorized
403Forbidden
404Not Found

响应参数:

参数名称参数说明类型schema
codeinteger(int32)integer(int32)
dataobject
msgstring

响应示例:

{
    "code": 0,
    "data": {},
    "msg": ""
}

后台登陆​

接口地址:/User/loginAdmin

请求方式:GET

请求数据类型:application/x-www-form-urlencoded

响应数据类型:*/*

接口描述:

请求参数:

参数名称参数说明请求类型是否必须数据类型schema
user用户对象truestring
createdqueryfalsestring(date-time)
emailqueryfalsestring
genderqueryfalsestring
integralqueryfalseinteger(int32)
introqueryfalsestring
lastLoginqueryfalsestring(date-time)
namequeryfalsestring
passwordqueryfalsestring
profilequeryfalsestring
rolequeryfalsestring
statusqueryfalseinteger(int32)
userAgequeryfalseinteger(int32)
userIdqueryfalseinteger(int32)
usernamequeryfalsestring
vipDisableTipqueryfalseboolean
vipExpireDatequeryfalsestring(date-time)
vipValidDatequeryfalsestring(date-time)

响应状态:

状态码说明schema
200OKResult
401Unauthorized
403Forbidden
404Not Found

响应参数:

参数名称参数说明类型schema
codeinteger(int32)integer(int32)
dataobject
msgstring

响应示例:

{
    "code": 0,
    "data": {},
    "msg": ""
}

用户角色信息接口

获取全部用户名称​

接口地址:/UserRole/getAllUserName

请求方式:GET

请求数据类型:application/x-www-form-urlencoded

响应数据类型:*/*

接口描述:

请求参数:

暂无

响应状态:

状态码说明schema
200OKUserNameVO
401Unauthorized
403Forbidden
404Not Found

响应参数:

参数名称参数说明类型schema
usernamestring

响应示例:

[
    {
        "username": ""
    }
]

获取全部角色信息​

接口地址:/UserRole/getAllUserRole

请求方式:GET

请求数据类型:application/x-www-form-urlencoded

响应数据类型:*/*

接口描述:

请求参数:

暂无

响应状态:

状态码说明schema
200OKRole
401Unauthorized
403Forbidden
404Not Found

响应参数:

参数名称参数说明类型schema
idinteger(int32)integer(int32)
namestring
sortstring

响应示例:

[
    {
        "id": 0,
        "name": "",
        "sort": ""
    }
]
Previous
接口开发
Next
3.x.x to 4.x.x
Was this helpful?