博客 分类专栏 专题 成员
帖子文章接口
2023-01-13 09:45:58

说明

这里是整个项目文章的核心,包括发帖,文章的获取等

接口列表

获取文章列表

  • 接口地址 /forum/loadArticle

  • 请求参数

    参数名 说明 是否必填
    pBoardId 父级板块ID
    boardId 板块ID
    orderType 0:热门1:发布时间2:最新发布
    pageNo 页码 否 默认1
  • 返回

      {
          "status":"success",
          "code":200,
          "info":"请求成功",
          "data":{
              "totalCount":13,
              "pageSize":15,
              "pageNo":1,
              "pageTotal":1,
              "list":[
                   {
                      "articleId":"5S7nyQHe6RPax6I",//文章ID
                      "boardId":10006,//板块ID
                      "boardName":"Vue",//板块名称
                      "pBoardId":10003,//父级板块
                      "pBoardName":"前端",//父级板块名称
                      "userId":"7966890361",//用户ID
                      "nickName":"程序员老罗",//昵称
                      "userIpAddress":"湖北省",//所在地
                      "title":"vscode配置好这些,写代码不起飞你来打我",//标题
                      "cover":"202301/d3QQeA298E4IBAT.png",//封面
                      "content":null,//内容 列表内容为空
                      "summary":"vscode代码块配置,配置好这些,可以提高写代码的效率,而且可以避免出错",//简介
                      "postTime":"2023-01-07 14:16:00",//发布时间
                      "readCount":64,//阅读数
                      "goodCount":1,//点赞数
                      "commentCount":1,//评论数
                      "topType":1,//置顶类型 0:未置顶 1:已置顶
                      "attachmentType":1,//附件类型 0:没附件 1:有附件
                      "status":1//状态 1 已审核 
                  }
              ]
          }
      }
    

获取文章详情

  • 接口地址 /forum/getArticleDetail

  • 请求参数

    参数名 说明 是否必填
    articleId 文章ID
  • 返回

      {
          "status":"success",
          "code":200,
          "info":"请求成功",
          "data":{
              "forumArticle":{
                      "articleId":"5S7nyQHe6RPax6I",//文章ID
                      "boardId":10006,//板块ID
                      "boardName":"Vue",//板块名称
                      "pBoardId":10003,//父级板块
                      "pBoardName":"前端",//父级板块名称
                      "userId":"7966890361",//用户ID
                      "nickName":"程序员老罗",//昵称
                      "userIpAddress":"湖北省",//所在地
                      "title":"vscode配置好这些,写代码不起飞你来打我",//标题
                      "cover":"202301/d3QQeA298E4IBAT.png",//封面
                      "content":null,//内容 列表内容为空
                      "summary":"vscode代码块配置,配置好这些,可以提高写代码的效率,而且可以避免出错",//简介
                      "postTime":"2023-01-07 14:16:00",//发布时间
                      "readCount":64,//阅读数
                      "goodCount":1,//点赞数
                      "commentCount":1,//评论数
                      "topType":1,//置顶类型 0:未置顶 1:已置顶
                      "attachmentType":1,//附件类型 0:没附件 1:有附件
                      "status":1//状态 1 已审核 
              },
              "attachment":{
                  "fileId":"641750977441264",//文件ID
                  "fileSize":9237,//文件大小
                  "fileName":"福利.zip",//文件名称
                  "downloadCount":26,//下载次数
                  "fileType":0,// 0:压缩包
                  "integral":0 //所需积分
              },
              "haveLike":false //是否已经点赞
          }
      }
    

评论文章

  • 接口地址 /forum/doLike

  • 请求参数

    参数名 说明 是否必填
    articleId 文章ID
  • 返回

      {
          "status":"success",
          "code":200,
          "info":"请求成功",
          "data":null
      }    
    

获取用户积分

  • 接口地址 /getUserIntegral

  • 请求参数

  • 返回

    {
      "status":"success",//登录状态 success成功  error 错误
      "code":200, //状态码 200 成功
      "info":"请求成功",
      "data":100 //用户积分
    }
    

下载附件

  • 接口地址 /forum/attachmentDownload

  • 请求参数

    参数名 说明 是否必填
    fileId 附件ID
  • 返回
    返回文件流,直接在新窗口中打开该窗口即可下载

发布文章获取板块

  • 接口地址 /forum/loadBoard4Post

  • 请求参数

  • 返回

      {
          "status":"success",
          "code":200,
          "info":"请求成功",
          "data":[
              {
                  "boardId":10002,//板块ID
                  "pBoardId":0,//父板块ID
                  "boardName":"Easybbs开发",//板块名称
                  "cover":null,//封面
                  "boardDesc":"Easybbs开发",//简介
                  "sort":1,//排序
                  "postType":1,//是否可以发帖 0:不可以 1:可以
                  "children":[//子版块
                      {
                          "boardId":10005,
                          "pBoardId":10002,
                          "boardName":"技术问题",
                          "cover":null,
                          "boardDesc":null,
                          "sort":1,
                          "postType":1,
                          "children":[
    
                          ]
                      },
                      {
                          "boardId":10017,
                          "pBoardId":10002,
                          "boardName":"bug反馈",
                          "cover":null,
                          "boardDesc":null,
                          "sort":2,
                          "postType":1,
                          "children":[
    
                          ]
                      }
                  ]
              }
          ]
      }
    

发布文章

  • 接口地址 /forum/postArticle

  • 请求参数

    参数名 说明 是否必填
    cover 封面,文件流
    attachment 附件,文件流
    integral 附件下载所需积分
    pBoardId 父级板块ID
    boardId 板块ID
    title 标题 长度 150
    content 内容
    markdownContent markdown内容 markdown编辑的时候必传
    editorType 编辑器类型 0:富文本 1:markdown 编辑类型
    summary 简介 长度200 编辑类型
  • 返回

      {
          "status":"success",
          "code":200,
          "info":"请求成功",
          "data":"xxxxx" //文章ID
      }    
    

修改文章获取详情

  • 接口地址 /forum/articleDetail4Update

  • 请求参数

    参数名 说明 是否必填
    articleId 文章ID
  • 返回

      {
          "status":"success",
          "code":200,
          "info":"请求成功",
          "data":{
              "forumArticle":{
                      "articleId":"5S7nyQHe6RPax6I",//文章ID
                      "boardId":10006,//板块ID
                      "boardName":"Vue",//板块名称
                      "pBoardId":10003,//父级板块
                      "pBoardName":"前端",//父级板块名称
                      "userId":"7966890361",//用户ID
                      "nickName":"程序员老罗",//昵称
                      "userIpAddress":"湖北省",//所在地
                      "title":"vscode配置好这些,写代码不起飞你来打我",//标题
                      "cover":"202301/d3QQeA298E4IBAT.png",//封面
                      "content":null,//内容 列表内容为空
                      "summary":"vscode代码块配置,配置好这些,可以提高写代码的效率,而且可以避免出错",//简介
                      "postTime":"2023-01-07 14:16:00",//发布时间
                      "readCount":64,//阅读数
                      "goodCount":1,//点赞数
                      "commentCount":1,//评论数
                      "topType":1,//置顶类型 0:未置顶 1:已置顶
                      "attachmentType":1,//附件类型 0:没附件 1:有附件
                      "status":1//状态 1 已审核 
              },
              "attachment":{
                  "fileId":"641750977441264",//文件ID
                  "fileSize":9237,//文件大小
                  "fileName":"福利.zip",//文件名称
                  "downloadCount":26,//下载次数
                  "fileType":0,// 0:压缩包
                  "integral":0 //所需积分
              }
          }
      }
    

修改文章

  • 接口地址 /forum/postArticle

  • 请求参数

    参数名 说明 是否必填
    cover 封面,文件流
    attachment 附件,文件流
    integral 附件下载所需积分
    pBoardId 父级板块ID
    boardId 板块ID
    title 标题 长度 150
    content 内容
    markdownContent markdown内容 markdown编辑的时候必传
    editorType 编辑器类型 0:富文本 1:markdown 编辑类型
    summary 简介 长度200 编辑类型
    attachmentType 0没有附件 1有附件
  • 返回

      {
          "status":"success",
          "code":200,
          "info":"请求成功",
          "data":"xxxxx" //文章ID
      }    
    

搜索

  • 接口地址 /forum/search

  • 请求参数

    参数名 说明 是否必填
    keyword 关键字 长度最少3
  • 返回

      {
          "status":"success",
          "code":200,
          "info":"请求成功",
          "data":{
              "totalCount":13,
              "pageSize":15,
              "pageNo":1,
              "pageTotal":1,
              "list":[
                   {
                      "articleId":"5S7nyQHe6RPax6I",//文章ID
                      "boardId":10006,//板块ID
                      "boardName":"Vue",//板块名称
                      "pBoardId":10003,//父级板块
                      "pBoardName":"前端",//父级板块名称
                      "userId":"7966890361",//用户ID
                      "nickName":"程序员老罗",//昵称
                      "userIpAddress":"湖北省",//所在地
                      "title":"vscode配置好这些,写代码不起飞你来打我",//标题
                      "cover":"202301/d3QQeA298E4IBAT.png",//封面
                      "content":null,//内容 列表内容为空
                      "summary":"vscode代码块配置,配置好这些,可以提高写代码的效率,而且可以避免出错",//简介
                      "postTime":"2023-01-07 14:16:00",//发布时间
                      "readCount":64,//阅读数
                      "goodCount":1,//点赞数
                      "commentCount":1,//评论数
                      "topType":1,//置顶类型 0:未置顶 1:已置顶
                      "attachmentType":1,//附件类型 0:没附件 1:有附件
                      "status":1//状态 1 已审核 
                  }
              ]
          }
      }  
    
目录