资讯模块
[TOC]
查询资讯接口
简要描述
- 用户端和管理端通用的资讯查询接口
请求URL
http://www.cmh.com/9000/zixun/article/query
请求方式
- GET
参数
参数名 | 必填 | 类型 | 说明 |
---|---|---|---|
currentPage | 否 | int | 当前页数 |
pageSize | 否 | int | 每页显示数 |
keyword | 否 | string | 关键词 |
state | 否 | int | 有效:0 无效:-1 |
type | 是 | int | 文章类型 |
queryType | 否 | int | 客户端查询:1,管理端查询:2 (默认为客户端) |
返回示例
{
"msg": "success",
"code": 200,
"data": {
"records": [
{
"id": "6597d393afe32c117c09a2c4193bb531",
"title": "2233",
"type": 1,
"content": "33",
"url": "",
"state": 0,
"beginDate": "2023-01-05",
"endDate": "2023-01-26"
},
{
"id": "0a77dc8dfb9ca7ea38bd2aaa551542ec",
"title": "11111111111111111",
"type": 1,
"content": "222222222222",
"url": "",
"state": 0,
"beginDate": "2022-10-10",
"endDate": "2022-10-11"
}
],
"total": 4,
"size": 2,
"current": 1,
"orders": [],
"optimizeCountSql": true,
"searchCount": true,
"countId": null,
"maxLimit": null,
"pages": 2
}
}
返回参数说明
参数名 | 类型 | 说明 |
---|---|---|
code | int | 成功:200, 错误:500,... |
msg | string | 响应信息 成功:success |
data | obj | 响应数据 |
data.records | arr | 响应的资讯数据集合 |
data.total | int | 分页总数 |
data.size | int | 每页条数 |
data.current | int | 当前页数 |
保存资讯接口
简要描述
- 保存资讯信息接口
请求URL
http://www.cmh.com/9000/zixun/article/save
请求方式
- POST
参数
参数名 | 必填 | 类型 | 说明 |
---|---|---|---|
title | 是 | string | 标题 |
content | 否 | string | 内容 |
state | 否 | int | 状态 |
type | 是 | int | 文章类型 |
url | 否 | string | 外站链接(当类型为外部文章时,此项为必填) |
beginDate | 是 | date | 生效日期 |
endDate | 是 | date | 失效日期 |
返回示例
{
"code": 200,
"msg": "null"
}
返回参数说明
参数名 | 类型 | 说明 |
---|---|---|
code | int | 成功:200, 错误:500,... |
更新资讯接口
简要描述
- 根据id更新资讯信息的接口
请求URL
http://www.cmh.com/9000/zixun/article/update
请求方式
- POST
参数
参数名 | 必填 | 类型 | 说明 |
---|---|---|---|
id | 是 | string | id |
title | 是 | string | 标题 |
content | 是 | string | 内容 |
destId | 是 | long | 目的地id |
state | 否 | int | 状态 |
type | 是 | int | 文章类型 |
url | 否 | string | 外站链接(当类型为外部文章时,此项为必填) |
beginDate | 是 | date | 生效日期 |
endDate | 是 | date | 失效日期 |
返回示例
{
"code": 200,
"msg": "null"
}
返回参数说明
参数名 | 类型 | 说明 |
---|---|---|
code | int | 成功:200, 错误:500,... |
删除资讯接口
简要描述
- 根据id删除资讯信息的接口
请求URL
http://www.cmh.com/9000/zixun/article/delete/{id}
请求方式
- POST
参数
参数名 | 必填 | 类型 | 说明 |
---|---|---|---|
id | 是 | string | id |
返回示例
{
"code": 200,
"msg": "null"
}
返回参数说明
参数名 | 类型 | 说明 |
---|---|---|
code | int | 成功:200 |