[关闭]
@iamfox 2018-08-06T17:18:37.000000Z 字数 15376 阅读 2177

幸福快车后台接口文档

车

1 基本要求

每个请求的JSON中都要包含自定义头信息，如下：

  1. {
  2.     "clientId": "xfkc", 
  3.     "clientType": "pc_web",
  4.     "timestamp": 1531189477255
  5. }
字段 .................. 名称 ................... 类型 ............ 长度 ...... 是否必填 ........ 备注
clientId 客户端id 字符 16 是 请求来源客户端，可选值有xfkc(幸福快车)、qyt（黔油通）、qsf（黔师傅）
clientType 客户端类型 字符 16 是 请求来源客户端类型，可选值有pc_web、android、ios、mobile_web、xcx
timestamp 当前时间戳 数值 16 是 精确到毫秒

1.1 基本返回

  1. {
  2.     "code":"0",
  3.     "message":"请求成功",
  4.     "data": ... //  可能是对象或数组或字符
  5. }

所有以/query结尾的get请求接口均为查询类请求，所有查询类请求的{请求JSON}都有如下通用字段：

  1. {
  2.     "resultType": "xxx",
  3.     "pageNo": 1,
  4.     "pageSize": 10,
  5.     "limit":100
  6. }
字段 .................. 名称 ................... 类型 ............ 长度 ...... 是否必填 ........ 备注
resultType 查询结果类型 字符 16 是 可选值有count(查结果数量)、unique（查单条）、list（查全部列表，默认最多100条），"pagination"(分页查)
pageNo 页数 数值 16 否 仅当resultType为pagination时可用
pageSize 每页的条数 数值 16 否 仅当resultType为pagination时可用
limit 条数 数值 16 否 当resultType为limit时，如果100条不满足要求可以修改

查询条数返回结构:

  1. {
  2.     "code":"0",
  3.     "message":"请求成功",
  4.     "data": 1000 //  count
  5. }

查询单条返回结构:

  1. {
  2.     "code":"0",
  3.     "message":"请求成功",
  4.     "data": ｛｝ //  unique
  5. }

查询列表返回结构:

  1. {
  2.     "code":"0",
  3.     "message":"请求成功",
  4.     "data": [] //  list
  5. }

查询分页返回结构:

  1. {
  2.     "code":"0",
  3.     "message":"请求成功",
  4.     "data": {   //  pagination
  5.         "nextPage": 1,  //  下一页页码
  6.         "firstPage": true,  //  是否是第一页
  7.         "startIndex": 0,    //  返回列表的起始索引
  8.         "totalCount": 4,    //  总条数
  9.         "pretPage": 1,  //  前一页页码
  10.         "pageNo": 1,    //  当前页码
  11.         "pageSize": 10, //  每页条数
  12.         "lastPage": true,
  13.         "list": [   //  和list查询时data结构一样
  14.         ],
  15.         "totalPage": 1, //  总页数
  16.     }
  17. }

2 运营模块接口

域名:

api.fengchixinxi.com

2.1 创建管理员 /api/admin/create

请求方法: POST

请求body结构： CreateAdminACmd

示例：

  1. {
  2.     "header": {
  3.         //  参照基本要求
  4.     },
  5.     "addPermissionIds": ["permissionId1", "permissionId2"],
  6.     "addRoleIds": ["roleId1", "roleId2"],
  7.     "enable": true,
  8.     "loginName": "xxx",
  9.     "mobile": "xxx",
  10.     "name": "xxx",
  11.     "password": "xxx"
  12. }
字段 .................. 名称 ................... 类型 ............ 长度 ...... 是否必填 ........ 备注
addPermissionIds 要添加的权限id集合 数组 否 赋予该用户角色不包含的额外权限
addRoleIds 要添加的角色id集合 数组 否 如果不传，会赋予一个“幸福快车运营团队默认角色”的role
enable 是否启用 布尔 否 默认启用
loginName 登录帐号名 字符 32 是
mobile 手机号 字符 16 否
name 真实姓名 字符 16 否
password 密码 字符 16 是 明文

返回data结构: AdminVO

示例：

  1. {
  2.     "code": "0",
  3.     "message": "操作成功",
  4.     "data": {
  5.         "enable": true,
  6.         "id": "1a16e6a6ccdf435fa4df0dcc6087fc3d",
  7.         "loginName": "xxx",
  8.         "mobile": "1860000000",
  9.         "name": "xxx",
  10.         "password": "a26610bfe749bee7f38d26fd50a1a33e",
  11.         "version": 0
  12.     }
  13. }

2.2 编辑管理员 /api/admin/modify

请求方法: PUT

请求body结构： ModifyAdminACmd

示例：

  1. {
  2.     "header": {
  3.         //  参照基本要求
  4.     },
  5.     "addPermissionIds": ["permissionId3"],
  6.     "addRoleIds": ["roleId3", "roleId4"],
  7.     "enable": true,
  8.     "mobile": "xxx",
  9.     "password": "xxx",
  10.     "removePermissionIds": ["permissionId1", "permissionId2"],
  11.     "removeRoleIds": ["roleId1"]
  12. }
字段 .................. 名称 ................... 类型 ............ 长度 ...... 是否必填 ........ 备注
addPermissionIds 要添加的权限id集合 数组 否 赋予该用户角色不包含的额外权限
addRoleIds 要添加的角色id集合 数组 否 如果不传，会赋予一个“幸福快车运营团队默认角色”的role
enable 是否启用 布尔 否 默认启用
mobile 手机号 字符 16 否
password 密码 字符 16 是 明文
removePermissionIds 要删除的权限id集合 数组 否
removeRoleIds 要删除的角色id集合 数组 否

返回data结构: AdminVO

示例：

  1. {
  2.     "code": "0",
  3.     "message": "操作成功",
  4.     "data": {
  5.         "enable": true,
  6.         "id": "1a16e6a6ccdf435fa4df0dcc6087fc3d",
  7.         "loginName": "xxx",
  8.         "mobile": "1860000000",
  9.         "name": "xxx",
  10.         "password": "a26610bfe749bee7f38d26fd50a1a33e",
  11.         "version": 0
  12.     }
  13. }

2.3 修改管理员状态 /api/admin/change_enable

请求方法: PUT

请求body结构： ChangeAdminEnableACmd

示例：

  1. {
  2.     "header": {
  3.         //  参照基本要求
  4.     },
  5.     "adminId": "xxx",
  6.     "enable": false
  7. }
字段 .................. 名称 ................... 类型 ............ 长度 ...... 是否必填 ........ 备注
adminId 要修改的管理员id 字符 32 是
enable 是否启用 布尔 是

返回data结构:

示例：

  1. {
  2.     "code": "0",
  3.     "message": "操作成功"
  4. }

2.4 删除管理员 /api/admin/remove

请求方法: DELETE

请求body结构： RemoveAdminACmd

示例：

  1. {
  2.     "header": {
  3.         //  参照基本要求
  4.     },
  5.     "adminId": "xxx"
  6. }
字段 .................. 名称 ................... 类型 ............ 长度 ...... 是否必填 ........ 备注
adminId 要删除的管理员id 字符 32 是

返回data结构:

示例：

  1. {
  2.     "code": "0",
  3.     "message": "操作成功"
  4. }

2.5 登录 /api/open/admin/login/check

请求方法: POST

请求body结构： AdminLoginCheckACmd

示例：

  1. {
  2.     "header": {
  3.         //  参照基本要求
  4.     },
  5.     "loginName": "xxx",
  6.     "password": "xxx"
  7. }
字段 .................. 名称 ................... 类型 ............ 长度 ...... 是否必填 ........ 备注
loginName 登录帐户名 字符 32 是
password 密码 字符 16 是

返回data结构:

示例：

  1. {
  2.     "code": "0",
  3.     "message": "操作成功",
  4.     "data": {
  5.         "clientId": "xfkc",
  6.         "clientType": "pc_web",
  7.         "createDate": 1531194332000,
  8.         "expireDate": 1531280732000,
  9.         "id": "16d3f7c938b54645bb48a42fa16d03f9",
  10.         "subjectId": "966904b914cb4921a171b5cd952fdd35",
  11.         "token": "eyJhbGciOiJIUzUxMiIsInppcCI6IkRFRiJ9.eNqqVkrOyUzNKwmpLEhVslIqSI4vT01S0oGKeqYAxSrSspOBIjn56Zl5fom5IGWJKbmZeQhVBUpWeaU5OTpKqRVApqGpsaGRhYG5sZGOUmZiCUTA0NLE2NioFgAAAP__.5q576SG-D236p5Rxd4ehs0h2dpgzRlnhm7sXGJdY26iPZ6Ey7Evu0CCaEMHOM9eoPWlSET3JXvDcJ4xHNN34_w"
  12.     }
  13. }
字段 .................. 名称 ................... 类型 ............ 备注
clientId 登录的客户端id 字符
clientType 登录的客户端类型 字符
createDate 登录令牌生成时间 时间戳
expireDate 登录令牌过期时间 时间戳
id 登录令牌id 字符
subjectId 登录管理员id 字符
token 登录令牌 字符 要将此令牌在客户端保存，并在每个后续请求的http header中设为loginToken的值

2.6 查询管理员 /api/admin/query

请求方法: GET

请求body结构： AdminViewQO

示例：

  1. {
  2.     "header": {
  3.         //  参照基本要求
  4.     },
  5.     "adminId": "xxx"
  6. }
字段 .................. 名称 ................... 类型 ............ 长度 ...... 是否必填 ........ 备注
adminId 要删除的管理员id 字符 32 是

返回data结构:

示例：

  1. {
  2.     "code": "0",
  3.     "message": "操作成功",
  4.     "data":{
  5.         ...
  6.     }
  7. }

2.7 查询菜单 /api/permission/page_link/query

请求方法: GET

请求body结构： PageLinkViewQO

示例：

  1. {
  2.     "header": {
  3.         //  参照基本要求
  4.     },
  5.     //  查询通用字段略...
  6.     "format2Level": true,
  7.     "menuKey": "xxx"
  8. }
字段 .................. 名称 ................... 类型 ............ 长度 ...... 是否必填 ........ 备注
format2Level 格式化为二级菜单 布尔 否 默认false，选了以后会返回前两级菜单（root节点不算一级），并且JSON结构中第二级菜单在第一级下面，仅当resultType为list时有效
menuKey 菜单标识 字符 16 是 可选：xfkc-left（幸福快车左边菜单）

返回data结构:

format2Level为true的结果示例：

  1. {
  2.     "code": "0",
  3.     "message": "请求成功",
  4.     "data": [
  5.         {
  6.             "root": false,  //  是否根节点，菜单是个树形数据
  7.             "id": "c9c23062d5a6452eb80064d9d2f6f884",
  8.             "uri": "",  //  跳转地址
  9.             "menuKey": "xfkc-left", // 菜单标识：幸福快车左边菜单
  10.             "name": "系统设置", //  显示在菜单上的名字
  11.             "treeData": {   //  树形数据
  12.                 "width": 6,     //  节点宽度，预排序遍历树算法
  13.                 "treeId": "xfkc-left",  //  树id
  14.                 "rightValue": 7,    //  节点右值，预排序遍历树算法
  15.                 "parentId": "xfkc-left",    //  分节点id
  16.                 "level": 2, //  层级，含根节点
  17.                 "leftValue": 2  //  节点左值，预排序遍历树算法
  18.             },
  19.             "subPageLinks": [   //  子菜单数组
  20.                 {
  21.                     "remove": false,
  22.                     "root": false,
  23.                     "menuKey": "xfkc-left",
  24.                     "treeData": {
  25.                         "rightValue": 6,
  26.                         "width": 4,
  27.                         "parentId": "c9c23062d5a6452eb80064d9d2f6f884",
  28.                         "treeId": "xfkc-left",
  29.                         "leftValue": 3,
  30.                         "level": 3
  31.                     },
  32.                     "name": "角色列表",
  33.                     "id": "72fa85d43d7b470fb993ef937f529929",
  34.                     "uri": ""
  35.                 }
  36.             ]
  37.         }
  38.     ]
  39. }

format2Level为false的结果示例：

  1. {
  2.     "code": "0",
  3.     "message": "请求成功",
  4.     "data": [   //  未做二级整理，全部列为一个数组的菜单
  5.         {
  6.             "id": "72fa85d43d7b470fb993ef937f529929",
  7.             "remove": false,
  8.             "name": "角色列表",
  9.             "uri": "",
  10.             "menuKey": "xfkc-left",
  11.             "treeData": {
  12.                 "width": 4,
  13.                 "level": 3,
  14.                 "leftValue": 3,
  15.                 "treeId": "xfkc-left",
  16.                 "parentId": "c9c23062d5a6452eb80064d9d2f6f884",
  17.                 "rightValue": 6
  18.             },
  19.             "root": false
  20.         },
  21.         {
  22.             "menuKey": "xfkc-left",
  23.             "treeData": {
  24.                 "parentId": "72fa85d43d7b470fb993ef937f529929",
  25.                 "level": 4,
  26.                 "width": 2,
  27.                 "rightValue": 5,
  28.                 "treeId": "xfkc-left",
  29.                 "leftValue": 4
  30.             },
  31.             "remove": false,
  32.             "name": "角色添加",
  33.             "uri": "",
  34.             "id": "8dae805638f34c55ae7986db04b29db5",
  35.             "root": false
  36.         },
  37.         {
  38.             "menuKey": "xfkc-left",
  39.             "id": "c9c23062d5a6452eb80064d9d2f6f884",
  40.             "uri": "",
  41.             "name": "系统设置",
  42.             "root": false,
  43.             "treeData": {
  44.                 "rightValue": 7,
  45.                 "parentId": "xfkc-left",
  46.                 "leftValue": 2,
  47.                 "width": 6,
  48.                 "level": 2,
  49.                 "treeId": "xfkc-left"
  50.             },
  51.             "remove": false
  52.         },
  53.         {
  54.             "treeData": {
  55.                 "leftValue": 1,
  56.                 "width": 8,
  57.                 "level": 1,
  58.                 "rightValue": 8,
  59.                 "treeId": "xfkc-left"
  60.             },
  61.             "name": "根节点",
  62.             "remove": false,
  63.             "menuKey": "xfkc-left",
  64.             "id": "xfkc-left",
  65.             "root": true
  66.         }
  67.     ]
  68. }

2.8 查询角色 /api/role/query

请求方法: GET

请求body结构： RoleViewQO

示例：

  1. {
  2.     "header": {
  3.         //  参照基本要求
  4.     },
  5.     //  查询通用字段略...
  6.     "format2Level": true,
  7.     "menuKey": "xxx"
  8. }
字段 .................. 名称 ................... 类型 ............ 长度 ...... 是否必填 ........ 备注
fetchPermissions 查询加载角色拥有的所有权限 布尔 否 默认false，仅当resultType为unique时有效
fetchPermissionClassification 查询加载的权限按上下级结构返回 布尔 否 默认为false，仅当resultType为unique时有效

返回data结构:

format2Level为true的结果示例：

  1. {
  2.     "code": "0",
  3.     "message": "请求成功",
  4.     "data": [
  5.         {
  6.             "root": false,  //  是否根节点，菜单是个树形数据
  7.             "id": "c9c23062d5a6452eb80064d9d2f6f884",
  8.             "uri": "",  //  跳转地址
  9.             "menuKey": "xfkc-left", // 菜单标识：幸福快车左边菜单
  10.             "name": "系统设置", //  显示在菜单上的名字
  11.             "treeData": {   //  树形数据
  12.                 "width": 6,     //  节点宽度，预排序遍历树算法
  13.                 "treeId": "xfkc-left",  //  树id
  14.                 "rightValue": 7,    //  节点右值，预排序遍历树算法
  15.                 "parentId": "xfkc-left",    //  分节点id
  16.                 "level": 2, //  层级，含根节点
  17.                 "leftValue": 2  //  节点左值，预排序遍历树算法
  18.             },
  19.             "subPageLinks": [   //  子菜单数组
  20.                 {
  21.                     "remove": false,
  22.                     "root": false,
  23.                     "menuKey": "xfkc-left",
  24.                     "treeData": {
  25.                         "rightValue": 6,
  26.                         "width": 4,
  27.                         "parentId": "c9c23062d5a6452eb80064d9d2f6f884",
  28.                         "treeId": "xfkc-left",
  29.                         "leftValue": 3,
  30.                         "level": 3
  31.                     },
  32.                     "name": "角色列表",
  33.                     "id": "72fa85d43d7b470fb993ef937f529929",
  34.                     "uri": ""
  35.                 }
  36.             ]
  37.         }
  38.     ]
  39. }

format2Level为false的结果示例：

  1. {
  2.     "code": "0",
  3.     "message": "请求成功",
  4.     "data": [   //  未做二级整理，全部列为一个数组的菜单
  5.         {
  6.             "id": "72fa85d43d7b470fb993ef937f529929",
  7.             "remove": false,
  8.             "name": "角色列表",
  9.             "uri": "",
  10.             "menuKey": "xfkc-left",
  11.             "treeData": {
  12.                 "width": 4,
  13.                 "level": 3,
  14.                 "leftValue": 3,
  15.                 "treeId": "xfkc-left",
  16.                 "parentId": "c9c23062d5a6452eb80064d9d2f6f884",
  17.                 "rightValue": 6
  18.             },
  19.             "root": false
  20.         },
  21.         {
  22.             "menuKey": "xfkc-left",
  23.             "treeData": {
  24.                 "parentId": "72fa85d43d7b470fb993ef937f529929",
  25.                 "level": 4,
  26.                 "width": 2,
  27.                 "rightValue": 5,
  28.                 "treeId": "xfkc-left",
  29.                 "leftValue": 4
  30.             },
  31.             "remove": false,
  32.             "name": "角色添加",
  33.             "uri": "",
  34.             "id": "8dae805638f34c55ae7986db04b29db5",
  35.             "root": false
  36.         },
  37.         {
  38.             "menuKey": "xfkc-left",
  39.             "id": "c9c23062d5a6452eb80064d9d2f6f884",
  40.             "uri": "",
  41.             "name": "系统设置",
  42.             "root": false,
  43.             "treeData": {
  44.                 "rightValue": 7,
  45.                 "parentId": "xfkc-left",
  46.                 "leftValue": 2,
  47.                 "width": 6,
  48.                 "level": 2,
  49.                 "treeId": "xfkc-left"
  50.             },
  51.             "remove": false
  52.         },
  53.         {
  54.             "treeData": {
  55.                 "leftValue": 1,
  56.                 "width": 8,
  57.                 "level": 1,
  58.                 "rightValue": 8,
  59.                 "treeId": "xfkc-left"
  60.             },
  61.             "name": "根节点",
  62.             "remove": false,
  63.             "menuKey": "xfkc-left",
  64.             "id": "xfkc-left",
  65.             "root": true
  66.         }
  67.     ]
  68. }

3 资讯模块接口

域名:

api.fengchixinxi.com

3.1 创建资讯频道 /api/article_channel/create

请求方法: POST

请求body结构： CreateArticleChannelSCmd

示例：

  1. {
  2.     "header": {
  3.         //  参照基本要求
  4.     },
  5.     "description": "体育频道",
  6.     "name": "体育",
  7.     "show": true,
  8.     "sort":0
  9. }
字段 .................. 名称 ................... 类型 ............ 长度 ...... 是否必填 ........ 备注
description 频道描述 字符 256 否
name 名称 字符 32 否
show 是否显示 布尔 否 默认false
sort 排序 数值 16 否 整数，数字越大查询时越靠前，默认0

返回data结构: ArticleChannelVO

示例：

  1. {
  2.     "code": "0",
  3.     "message": "操作成功",
  4.     "data": {
  5.         "name": "体育",
  6.         "show": true,
  7.         "description": "体育频道",
  8.         "id": "2ad23512910346c387b52f9b96dbf753",
  9.         "sort": 0
  10.     }
  11. }

3.2 修改资讯频道 /api/article_channel/modify

请求方法: PUT

请求body结构： ModifyArticleChannelSCmd

示例：

  1. {
  2.     "header": {
  3.         //  参照基本要求
  4.     },
  5.     "articleChannelId":"xxx",
  6.     "description": "体育频道",
  7.     "name": "体育",
  8.     "show": true,
  9.     "sort":0
  10. }
字段 .................. 名称 ................... 类型 ............ 长度 ...... 是否必填 ........ 备注
articleChannelId 主键 字符 32 是 要修改的频道id
description 频道描述 字符 256 否
name 名称 字符 32 否
show 是否显示 布尔 否 默认false
sort 排序 数值 16 否 整数，数字越大查询时越靠前，默认0

返回data结构: ArticleChannelVO

示例：

  1. {
  2.     "code": "0",
  3.     "message": "操作成功",
  4.     "data": {
  5.         "name": "体育",
  6.         "show": true,
  7.         "description": "体育频道",
  8.         "id": "2ad23512910346c387b52f9b96dbf753",
  9.         "sort": 0
  10.     }
  11. }

3.3 修改资讯频道显示状态 /api/article_channel/change_show

请求方法: PUT

请求body结构： ChangeArticleChannelShowSCmd

示例：

  1. {
  2.     "header": {
  3.         //  参照基本要求
  4.     },
  5.     "articleChannelId":"xxx",
  6.     "show": true
  7. }
字段 .................. 名称 ................... 类型 ............ 长度 ...... 是否必填 ........ 备注
articleChannelId 主键 字符 32 是 要修改的频道id
show 是否显示 布尔 否 默认false

返回data结构: null

示例：

  1. {
  2.     "code": "0",
  3.     "message": "操作成功"
  4. }

3.4 删除资讯频道 /api/article_channel/delete

请求方法: DELETE

请求body结构： DeleteArticleChannelSCmd
物理删除，属于该频道的资讯将变成无频道资讯

示例：

  1. {
  2.     "header": {
  3.         //  参照基本要求
  4.     },
  5.     "articleChannelId":"xxx"
  6. }
字段 .................. 名称 ................... 类型 ............ 长度 ...... 是否必填 ........ 备注
articleChannelId 主键 字符 32 是 要删除的频道id

返回data结构: null

示例：

  1. {
  2.     "code": "0",
  3.     "message": "操作成功"
  4. }

3.5 创建资讯 /api/article/create

请求方法: POST

请求body结构： CreateArticleSCmd

示例：

  1. {
  2.     "header": {
  3.         //  参照基本要求
  4.     },
  5.     "articleChannelId": "2ad23512910346c387b52f9b96dbf753",
  6.     "content": "xxxxxxxxxxxxxxxxxxxxxxx",
  7.     "sort": 0,
  8.     "subhead": "这你也信？",
  9.     "title": "中国队勇夺世界杯",
  10.     "titleImageId": "xxx"
  11. }
字段 .................. 名称 ................... 类型 ............ 长度 ...... 是否必填 ........ 备注
articleChannelId 所属频道id 字符 32 否
content 正文 字符 否 富文本
subhead 副标题 字符 256 否
title 标题 字符 128 否
sort 排序 数值 16 否 整数，数字越大查询时越靠前，默认0
titleImageId 标题图片id 字符 32 是 图片上传接口返回的图片id

返回data结构: ArticleVO

示例：

  1. {
  2.     "code": "0",
  3.     "message": "操作成功",
  4.     "data": {
  5.         "channel": {
  6.             "id": "c496ccd010754edbb48d6c638eae5828"
  7.         },
  8.         "show": false,
  9.         "subhead": "这你也信？",
  10.         "check": "wait",
  11.         "id": "71e997971e41487aad67640c74794fd4",
  12.         "sort": 0,
  13.         "title": "中国队勇夺世界杯",
  14.         "content": "xxxxxxxxxxxxxxxxxxxxxxx",
  15.         "createDate": 1533408448594
  16.     }
  17. }
字段 .................. 名称 ................... 类型 ............ 备注
channel.id 所属频道id 字符
id 资讯id 字符
content 正文 字符 富文本
subhead 副标题 字符
title 标题 字符
sort 排序 数值 整数，数字越大查询时越靠前，默认0
show 是否显示 布尔 用于控制前台显示
check 审核状态 字符 wait待审核，approve通过，disapprove未通过
createDate 创建时间 数值 时间戳，精确到毫秒

3.6 修改资讯 /api/article/modify

请求方法: PUT

请求body结构： ModifyArticleSCmd

示例：

  1. {
  2.     "header": {
  3.         //  参照基本要求
  4.     },
  5.     "articleId":"xxx",
  6.     "articleChannelId": "2ad23512910346c387b52f9b96dbf753",
  7.     "content": "xxxxxxxxxxxxxxxxxxxxxxx",
  8.     "sort": 0,
  9.     "subhead": "这你也信？",
  10.     "title": "中国队勇夺世界杯",
  11.     "titleImageId": "xxx"
  12. }
字段 .................. 名称 ................... 类型 ............ 长度 ...... 是否必填 ........ 备注
articleId 资讯id 字符 32 否 要修改的资讯id
articleChannelId 所属频道id 字符 32 否
content 正文 字符 否 富文本
subhead 副标题 字符 256 否
title 标题 字符 128 否
sort 排序 数值 16 否 整数，数字越大查询时越靠前，默认0
titleImageId 标题图片id 字符 32 是 图片上传接口返回的图片id

返回data结构: ArticleVO

示例：

  1. {
  2.     "code": "0",
  3.     "message": "操作成功",
  4.     "data": {
  5.         "channel": {
  6.             "id": "c496ccd010754edbb48d6c638eae5828"
  7.         },
  8.         "show": false,
  9.         "subhead": "这你也信？",
  10.         "check": "wait",
  11.         "id": "71e997971e41487aad67640c74794fd4",
  12.         "sort": 0,
  13.         "title": "中国队勇夺世界杯",
  14.         "content": "xxxxxxxxxxxxxxxxxxxxxxx",
  15.         "createDate": 1533408448594
  16.     }
  17. }
字段 .................. 名称 ................... 类型 ............ 备注
channel.id 所属频道id 字符
id 资讯id 字符
content 正文 字符 富文本
subhead 副标题 字符
title 标题 字符
sort 排序 数值 整数，数字越大查询时越靠前，默认0
show 是否显示 布尔 用于控制前台显示
check 审核状态 字符 wait待审核，approve通过，disapprove未通过
createDate 创建时间 数值 时间戳，精确到毫秒

3.7 审核资讯 /api/article/check

请求方法: PUT

请求body结构： CheckArticleSCmd
物理删除，属于该频道的资讯将变成无频道资讯

示例：

  1. {
  2.     "header": {
  3.         //  参照基本要求
  4.     },
  5.     "articleId":"xxx",
  6.     "approve":true
  7. }
字段 .................. 名称 ................... 类型 ............ 长度 ...... 是否必填 ........ 备注
articleId 主键 字符 32 是 要审核的频道id
approve 是否通过审核 布尔 是

返回data结构: null

示例：

  1. {
  2.     "code": "0",
  3.     "message": "操作成功"
  4. }

3.8 查询资讯 /api/article/query

请求方法: GET

请求body结构： ArticleViewQO

示例：

  1. {
  2.     "header": {
  3.         //  参照基本要求
  4.     },
  5.     "adminId": "xxx"
  6. }
字段 .................. 名称 ................... 类型 ............ 长度 ...... 是否必填 ........ 备注
adminId 要删除的管理员id 字符 32 是

返回data结构:

示例：

  1. {
  2.     "code": "0",
  3.     "message": "操作成功",
  4.     "data":{
  5.         ...
  6.     }
  7. }

3 车队模块接口

域名:

api.fengchixinxi.com

3.1 创建车队 /api/motorcade/create

请求方法: POST

请求body结构： CreateMotorcadeSCmd

示例：

  1. {
  2.     "header": {
  3.         //  参照基本要求
  4.     },
  5.     "albumImageIds": ["2", "3"],
  6.     "captainId": "xxx",
  7.     "flagImageId": "4",
  8.     "intro": "oooooooooooo",
  9.     "name": "法拉利车队",
  10.     "sort": 0
  11. }
字段 .................. 名称 ................... 类型 ............ 长度 ...... 是否必填 ........ 备注
albumImageIds 相册图片id 数组 否 上传图片接口返回的图片id集合
name 名称 字符 32 否
captainId 队长id 字符 否 用户查询接口返回的id
flagImageId 队标图片id 字符 否 上传图片接口返回的id
intro 介绍 字符 否 富文本
sort 排序 数值 16 否 整数，数字越大查询时越靠前，默认0

返回data结构: MotorcadeVO

示例：

  1. {
  2.     "code": "0",
  3.     "message": "操作成功",
  4.     "data": {
  5.         "captainId": "xxx",
  6.         "intro": "oooooooooooo",
  7.         "name": "法拉利车队",
  8.         "show": false,      //  显示
  9.         "onTop": false,     //  置顶
  10.         "flagImageId": "4",
  11.         "check": "wait",    // wait待审核,approve已通过,disapprove未通过
  12.         "id": "de9dda877ae14add8ca4e252a729fe9a",
  13.         "sort": 0,  //  排序，大的在前
  14.         "createDate": 1533575122805
  15.     }
  16. }

3.2 编辑车队 /api/motorcade/modify

请求方法: PUT

请求body结构： ModifyMotorcadeSCmd

示例：

  1. {
  2.     "header": {
  3.         //  参照基本要求
  4.     },
  5.     "addAlbumImageIds": ["3","4"],  //  新增的相册图片
  6.     "removeAlbumImageIds": ["2"],   //  删掉的相册图片
  7.     "captainId": "xxx",
  8.     "flagImageId": "3",
  9.     "intro": "oooooooooooo",
  10.     "motorcadeId": "de9dda877ae14add8ca4e252a729fe9a",
  11.     "name": "法拉利车队",
  12.     "sort": 1
  13. }
字段 .................. 名称 ................... 类型 ............ 长度 ...... 是否必填 ........ 备注
addAlbumImageIds 新增相册图片id 数组 否 新增的相册图片id集合
removeAlbumImageIds 删除相册图片id 数组 否 删掉的相册图片id集合
name 名称 字符 32 否
captainId 队长id 字符 否 用户查询接口返回的id
flagImageId 队标图片id 字符 否 上传图片接口返回的id
intro 介绍 字符 否 富文本
sort 排序 数值 16 否 整数，数字越大查询时越靠前，默认0

返回data结构: MotorcadeVO

示例：

  1. {
  2.     "code": "0",
  3.     "message": "操作成功",
  4.     "data": {
  5.         "captainId": "xxx",
  6.         "intro": "oooooooooooo",
  7.         "name": "法拉利车队",
  8.         "show": false,      //  显示
  9.         "onTop": false,     //  置顶
  10.         "flagImageId": "4",
  11.         "check": "wait",    // wait待审核,approve已通过,disapprove未通过
  12.         "id": "de9dda877ae14add8ca4e252a729fe9a",
  13.         "sort": 0,  //  排序，大的在前
  14.         "createDate": 1533575122805
  15.     }
  16. }

3.3 审核车队 /api/motorcade/check

请求方法: PUT

请求body结构： CheckMotorcadeSCmd

示例：

  1. {
  2.     "header": {
  3.         //  参照基本要求
  4.     },
  5.     "approve": true,
  6.     "motorcadeId": "de9dda877ae14add8ca4e252a729fe9a"
  7. }
字段 .................. 名称 ................... 类型 ............ 长度 ...... 是否必填 ........ 备注
motorcadeId 车队id 字符 32 是
approve 队长id 布尔 否 用户查询接口返回的id

返回data结构: MotorcadeVO

示例：

  1. {
  2.     "code": "0",
  3.     "message": "操作成功"
  4. }
添加新批注
在作者公开此批注前，只有你和作者可见。
回复批注