完整接口文档

想要加入开发？没问题！！！这里有完整的接口文档！

标签控制器

POST addNewTagApi

POST /tag/add

请求参数

名称	位置	类型	必选	说明
tagName	query	string	是	none

返回示例

{
  "code": 0,
  "msg": "",
  "data": {
    "id": 0,
    "name": "",
    "createdAt": "",
    "updatedAt": "",
    "deletedAt": ""
  }
}

返回结果

状态码	状态码含义	说明	数据模型
200	OK	none	ApiResponseTag

GET listTagsApi

GET /tag

返回示例

{
  "code": 0,
  "msg": "",
  "data": [
    {
      "tagId": "",
      "tagName": "",
      "articleCount": 0
    }
  ]
}

返回结果

状态码	状态码含义	说明	数据模型
200	OK	none	ApiResponseListTagVO

测试控制器

GET hello

GET /test/hello

返回示例

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

返回结果

状态码	状态码含义	说明	数据模型
200	OK	none	ApiResponseObject

用户控制器

POST login

POST /user/login

请求参数

名称	位置	类型	必选	说明
userEmail	query	string	否	none
password	query	string	否	none

返回示例

{
  "code": 0,
  "msg": "",
  "data": {
    "id": "",
    "nickname": "",
    "email": "",
    "avatar": "",
    "createdAt": "",
    "oauthProvider": ""
  }
}

返回结果

状态码	状态码含义	说明	数据模型
200	OK	none	ApiResponseUserVO

POST registerApi

POST /user/register

Body 请求参数

{
  "nickname": "string",
  "email": "string",
  "password": "string"
}

请求参数

名称	位置	类型	必选	说明
body	body	UserRegisterDTO	否	none

返回示例

{
  "code": 0,
  "msg": "",
  "data": {
    "id": "",
    "nickname": "",
    "email": "",
    "avatar": "",
    "createdAt": "",
    "oauthProvider": ""
  }
}

返回结果

状态码	状态码含义	说明	数据模型
200	OK	none	ApiResponseUserVO

GET getCurrentUser

GET /user/info

返回示例

{
  "code": 0,
  "msg": "",
  "data": {
    "id": "",
    "nickname": "",
    "email": "",
    "avatar": "",
    "createdAt": "",
    "oauthProvider": ""
  }
}

返回结果

状态码	状态码含义	说明	数据模型
200	OK	none	ApiResponseUserVO

PATCH updateNickname

PATCH /user/update/nickname

Body 请求参数

"string"

请求参数

名称	位置	类型	必选	说明
body	body	string	否	none

返回示例

{
  "code": 0,
  "msg": "",
  "data": {
    "id": "",
    "nickname": "",
    "email": "",
    "avatar": "",
    "createdAt": "",
    "oauthProvider": ""
  }
}

返回结果

状态码	状态码含义	说明	数据模型
200	OK	none	ApiResponseUserVO

后台管理控制器

POST login

POST /admin/login

请求参数

名称	位置	类型	必选	说明
userEmail	query	string	否	none
password	query	string	否	none

返回示例

{
  "code": 0,
  "msg": "",
  "data": {
    "id": "",
    "nickname": "",
    "email": "",
    "avatar": "",
    "createdAt": "",
    "oauthProvider": ""
  }
}

返回结果

状态码	状态码含义	说明	数据模型
200	OK	none	ApiResponseUserVO

GET getCurrentUser

GET /admin/userInfo

返回示例

{
  "code": 0,
  "msg": "",
  "data": {
    "id": "",
    "nickname": "",
    "email": "",
    "avatar": "",
    "createdAt": "",
    "oauthProvider": ""
  }
}

返回结果

状态码	状态码含义	说明	数据模型
200	OK	none	ApiResponseUserVO

POST addArticleApi

POST /admin/article

Body 请求参数

{
  "title": "string",
  "content": "string",
  "cover": "string",
  "categoryId": "string",
  "tags": "string",
  "isPublished": true,
  "shortUrl": "string",
  "isTop": true,
  "isHot": true,
  "isOriginal": true
}

请求参数

名称	位置	类型	必选	说明
body	body	ArticleDTO	否	none

返回示例

{
  "code": 0,
  "msg": "",
  "data": {
    "id": "",
    "title": "",
    "summary": "",
    "toc": "",
    "content": "",
    "author": "",
    "cover": "",
    "category": "",
    "tags": "",
    "views": 0,
    "likes": 0,
    "comments": 0,
    "shortUrl": "",
    "isPublished": false,
    "createdAt": "",
    "updatedAt": "",
    "deletedAt": "",
    "isTop": false,
    "isHot": false,
    "isOriginal": false
  }
}

返回结果

状态码	状态码含义	说明	数据模型
200	OK	none	ApiResponseArticleVO

DELETE deleteArticleApi

DELETE /admin/article/

请求参数

名称	位置	类型	必选	说明
id	path	string	是	none

返回示例

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

返回结果

状态码	状态码含义	说明	数据模型
200	OK	none	ApiResponseString

PATCH updateArticleApi

PATCH /admin/article/

Body 请求参数

{
  "title": "string",
  "content": "string",
  "cover": "string",
  "categoryId": "string",
  "tags": "string",
  "isPublished": true,
  "shortUrl": "string",
  "isTop": true,
  "isHot": true,
  "isOriginal": true
}

请求参数

名称	位置	类型	必选	说明
id	path	string	是	none
body	body	ArticleDTO	否	none

返回示例

{
  "code": 0,
  "msg": "",
  "data": {
    "id": "",
    "title": "",
    "summary": "",
    "toc": "",
    "content": "",
    "author": "",
    "cover": "",
    "category": "",
    "tags": "",
    "views": 0,
    "likes": 0,
    "comments": 0,
    "shortUrl": "",
    "isPublished": false,
    "createdAt": "",
    "updatedAt": "",
    "deletedAt": "",
    "isTop": false,
    "isHot": false,
    "isOriginal": false
  }
}

返回结果

状态码	状态码含义	说明	数据模型
200	OK	none	ApiResponseArticleVO

GET getArticleById

GET /admin/article/

请求参数

名称	位置	类型	必选	说明
id	path	string	是	none

返回示例

{
  "code": 0,
  "msg": "",
  "data": {
    "id": "",
    "title": "",
    "summary": "",
    "toc": "",
    "content": "",
    "author": "",
    "cover": "",
    "categoryId": "",
    "tags": "",
    "views": 0,
    "likes": 0,
    "comments": 0,
    "shortUrl": "",
    "isPublished": false,
    "createdAt": "",
    "updatedAt": "",
    "deletedAt": "",
    "isTop": false,
    "isHot": false,
    "isOriginal": false
  }
}

返回结果

状态码	状态码含义	说明	数据模型
200	OK	none	ApiResponseArticleVO

GET listAllCategories

GET /admin/category

返回示例

{
  "code": 0,
  "msg": "",
  "data": [
    {
      "id": "",
      "name": "",
      "shortUrl": ""
    }
  ]
}

返回结果

状态码	状态码含义	说明	数据模型
200	OK	none	ApiResponseListCategoryVO

POST addCategoryApi

POST /admin/category

Body 请求参数

{
  "name": "string",
  "shortUrl": "string",
  "type": true
}

请求参数

名称	位置	类型	必选	说明
body	body	AddCategory	否	none

返回示例

{
  "code": 0,
  "msg": "",
  "data": {
    "id": "",
    "name": "",
    "shortUrl": ""
  }
}

返回结果

状态码	状态码含义	说明	数据模型
200	OK	none	ApiResponseCategoryVO

PATCH updateArticleApi

PATCH /admin/article/toggle/

Body 请求参数

{
  "isPublished": true,
  "isTop": true,
  "isHot": true,
  "isOriginal": true
}

请求参数

名称	位置	类型	必选	说明
id	path	string	是	none
body	body	PostStatusToggle	否	none

返回示例

{
  "code": 0,
  "msg": "",
  "data": {
    "id": "",
    "title": "",
    "summary": "",
    "toc": "",
    "content": "",
    "author": "",
    "cover": "",
    "categoryId": "",
    "tags": "",
    "views": 0,
    "likes": 0,
    "comments": 0,
    "shortUrl": "",
    "isPublished": false,
    "createdAt": "",
    "updatedAt": "",
    "deletedAt": "",
    "isTop": false,
    "isHot": false,
    "isOriginal": false
  }
}

返回结果

状态码	状态码含义	说明	数据模型
200	OK	none	ApiResponseArticleVO

GET listAllArticlesByPageAdmin

GET /admin/article/all

请求参数

名称	位置	类型	必选	说明
page	query	integer	是	none
pageSize	query	integer	是	none

返回示例

{
  "code": 0,
  "msg": "",
  "data": [
    {
      "id": "",
      "title": "",
      "summary": "",
      "toc": "",
      "content": "",
      "author": "",
      "cover": "",
      "category": "",
      "tags": "",
      "views": 0,
      "likes": 0,
      "comments": 0,
      "shortUrl": "",
      "isPublished": false,
      "createdAt": "",
      "updatedAt": "",
      "deletedAt": "",
      "isTop": false,
      "isHot": false,
      "isOriginal": false
    }
  ]
}

返回结果

状态码	状态码含义	说明	数据模型
200	OK	none	ApiResponseListArticleVO

PATCH toggleStatusUpdateApi

PATCH /admin/statusUpdate/toggle/

Body 请求参数

{
  "isPublished": true,
  "isTop": true,
  "isHot": true,
  "isOriginal": true
}

请求参数

名称	位置	类型	必选	说明
id	path	string	是	none
body	body	PostStatusToggle	否	none

返回示例

{
  "code": 0,
  "msg": "",
  "data": {
    "id": "",
    "title": "",
    "summary": "",
    "content": "",
    "authorName": "",
    "img": "",
    "categoryId": "",
    "views": 0,
    "likes": 0,
    "comments": 0,
    "shortUrl": "",
    "isPublished": false,
    "createdAt": "",
    "updatedAt": "",
    "deletedAt": "",
    "isTop": false,
    "isHot": false,
    "isOriginal": false
  }
}

返回结果

状态码	状态码含义	说明	数据模型
200	OK	none	ApiResponseStatusUpdateVO

GET listAllStatusUpdatesByPageAdmin

GET /admin/statusUpdate/all

请求参数

名称	位置	类型	必选	说明
page	query	integer	是	none
pageSize	query	integer	是	none

返回示例

{
  "code": 0,
  "msg": "",
  "data": [
    {
      "id": "",
      "title": "",
      "summary": "",
      "content": "",
      "authorName": "",
      "img": "",
      "categoryId": "",
      "views": 0,
      "likes": 0,
      "comments": 0,
      "shortUrl": "",
      "isPublished": false,
      "createdAt": "",
      "updatedAt": "",
      "deletedAt": "",
      "isTop": false,
      "isHot": false,
      "isOriginal": false
    }
  ]
}

返回结果

状态码	状态码含义	说明	数据模型
200	OK	none	ApiResponseListStatusUpdateVO

POST addStatusUpdateApi

POST /admin/statusUpdate

Body 请求参数

{
  "title": "string",
  "summary": "string",
  "content": "string",
  "img": "string",
  "categoryId": "string",
  "shortUrl": "string",
  "isPublished": true,
  "isTop": true,
  "isHot": true,
  "isOriginal": true
}

请求参数

名称	位置	类型	必选	说明
body	body	StatusUpdateDTO	否	none

返回示例

{
  "code": 0,
  "msg": "",
  "data": {
    "id": "",
    "title": "",
    "summary": "",
    "content": "",
    "authorName": "",
    "img": "",
    "categoryId": "",
    "views": 0,
    "likes": 0,
    "comments": 0,
    "shortUrl": "",
    "isPublished": false,
    "createdAt": "",
    "updatedAt": "",
    "deletedAt": "",
    "isTop": false,
    "isHot": false,
    "isOriginal": false
  }
}

返回结果

状态码	状态码含义	说明	数据模型
200	OK	none	ApiResponseStatusUpdateVO

DELETE deleteStatusUpdateApi

DELETE /admin/statusUpdate/

请求参数

名称	位置	类型	必选	说明
id	path	string	是	none

返回示例

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

返回结果

状态码	状态码含义	说明	数据模型
200	OK	none	ApiResponseString

PATCH updateStatusUpdateApi

PATCH /admin/statusUpdate/

Body 请求参数

{
  "title": "string",
  "summary": "string",
  "content": "string",
  "img": "string",
  "categoryId": "string",
  "shortUrl": "string",
  "isPublished": true,
  "isTop": true,
  "isHot": true,
  "isOriginal": true
}

请求参数

名称	位置	类型	必选	说明
id	path	string	是	none
body	body	StatusUpdateDTO	否	none

返回示例

{
  "code": 0,
  "msg": "",
  "data": {
    "id": "",
    "title": "",
    "summary": "",
    "content": "",
    "authorName": "",
    "img": "",
    "categoryId": "",
    "views": 0,
    "likes": 0,
    "comments": 0,
    "shortUrl": "",
    "isPublished": false,
    "createdAt": "",
    "updatedAt": "",
    "deletedAt": "",
    "isTop": false,
    "isHot": false,
    "isOriginal": false
  }
}

返回结果

状态码	状态码含义	说明	数据模型
200	OK	none	ApiResponseStatusUpdateVO

GET getStatusUpdateById

GET /admin/statusUpdate/

请求参数

名称	位置	类型	必选	说明
id	path	string	是	none

返回示例

{
  "code": 0,
  "msg": "",
  "data": {
    "id": "",
    "title": "",
    "summary": "",
    "content": "",
    "authorName": "",
    "img": "",
    "categoryId": "",
    "views": 0,
    "likes": 0,
    "comments": 0,
    "shortUrl": "",
    "isPublished": false,
    "createdAt": "",
    "updatedAt": "",
    "deletedAt": "",
    "isTop": false,
    "isHot": false,
    "isOriginal": false
  }
}

返回结果

状态码	状态码含义	说明	数据模型
200	OK	none	ApiResponseStatusUpdateVO

POST addPageApi

POST /admin/page

Body 请求参数

{
  "title": "string",
  "description": "string",
  "refPath": "string",
  "content": "string",
  "enable": true,
  "canComment": true
}

请求参数

名称	位置	类型	必选	说明
body	body	PageDTO	否	none

返回示例

{
  "code": 0,
  "msg": "",
  "data": {
    "id": "",
    "title": "",
    "description": "",
    "refPath": "",
    "toc": "",
    "content": "",
    "views": 0,
    "likes": 0,
    "comments": 0,
    "commentId": "",
    "enable": false,
    "canDelete": false,
    "createdAt": "",
    "updatedAt": ""
  }
}

返回结果

状态码	状态码含义	说明	数据模型
200	OK	none	ApiResponsePageVO

PATCH updatePageApi

PATCH /admin/page/

Body 请求参数

{
  "title": "string",
  "description": "string",
  "refPath": "string",
  "content": "string",
  "enable": true,
  "canComment": true
}

请求参数

名称	位置	类型	必选	说明
id	path	string	是	none
body	body	PageDTO	否	none

返回示例

{
  "code": 0,
  "msg": "",
  "data": {
    "id": "",
    "title": "",
    "description": "",
    "refPath": "",
    "toc": "",
    "content": "",
    "views": 0,
    "likes": 0,
    "comments": 0,
    "commentId": "",
    "enable": false,
    "canDelete": false,
    "createdAt": "",
    "updatedAt": ""
  }
}

返回结果

状态码	状态码含义	说明	数据模型
200	OK	none	ApiResponsePageVO

DELETE deletePageApi

DELETE /admin/page/

请求参数

名称	位置	类型	必选	说明
id	path	string	是	none

返回示例

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

返回结果

状态码	状态码含义	说明	数据模型
200	OK	none	ApiResponseString

GET getPageById

GET /admin/page/

请求参数

名称	位置	类型	必选	说明
id	path	string	是	none

返回示例

{
  "code": 0,
  "msg": "",
  "data": {
    "id": "",
    "title": "",
    "description": "",
    "refPath": "",
    "toc": "",
    "content": "",
    "views": 0,
    "likes": 0,
    "comments": 0,
    "commentId": "",
    "enable": false,
    "canDelete": false,
    "createdAt": "",
    "updatedAt": ""
  }
}

返回结果

状态码	状态码含义	说明	数据模型
200	OK	none	ApiResponsePageVO

GET listAllPagesByPageAdmin

GET /admin/page/all

请求参数

名称	位置	类型	必选	说明
page	query	integer	是	none
pageSize	query	integer	是	none

返回示例

{
  "code": 0,
  "msg": "",
  "data": [
    {
      "id": "",
      "title": "",
      "description": "",
      "refPath": "",
      "toc": "",
      "content": "",
      "views": 0,
      "likes": 0,
      "comments": 0,
      "commentId": "",
      "enable": false,
      "canDelete": false,
      "createdAt": "",
      "updatedAt": ""
    }
  ]
}

返回结果

状态码	状态码含义	说明	数据模型
200	OK	none	ApiResponseListPageVO

PUT updateWebsiteInfo

PUT /admin/website-info

请求参数

名称	位置	类型	必选	说明
key	query	string	是	none
value	query	string	是	none

返回示例

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

返回结果

状态码	状态码含义	说明	数据模型
200	OK	none	ApiResponseString

PATCH togglePageApi

PATCH /admin/page/toggle/

Body 请求参数

{
  "isPublished": true,
  "isTop": true,
  "isHot": true,
  "isOriginal": true
}

请求参数

名称	位置	类型	必选	说明
id	path	string	是	none
body	body	PostStatusToggle	否	none

返回示例

{
  "code": 0,
  "msg": "",
  "data": {
    "id": "",
    "title": "",
    "description": "",
    "refPath": "",
    "toc": "",
    "content": "",
    "views": 0,
    "likes": 0,
    "comments": 0,
    "commentId": "",
    "enable": false,
    "canDelete": false,
    "createdAt": "",
    "updatedAt": ""
  }
}

返回结果

状态码	状态码含义	说明	数据模型
200	OK	none	ApiResponsePageVO

PUT updateWebsiteInfo

PUT /admin/config

请求参数

名称	位置	类型	必选	说明
key	query	string	是	none
value	query	string	是	none

返回示例

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

返回结果

状态码	状态码含义	说明	数据模型
200	OK	none	ApiResponseString

归档控制器

GET getArchiveApi

GET /archive

返回示例

{
  "code": 0,
  "msg": "",
  "data": {
    "{year=0, @required={year=false}, @class={year=int}, @comment={year=}}": {
      "articleCount": 0,
      "statusUpdateCount": 0,
      "articles": [
        {
          "title": "",
          "shortUrl": "",
          "category": "",
          "createdAt": ""
        }
      ],
      "statusUpdates": [
        {
          "title": "",
          "shortUrl": "",
          "category": "",
          "createdAt": ""
        }
      ]
    }
  }
}

返回结果

状态码	状态码含义	说明	数据模型
200	OK	none	ApiResponseMapArchiveSummary

文章控制器

GET 获取所有文章短链接

GET /article/shortLinks

返回示例

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

返回结果

状态码	状态码含义	说明	数据模型
200	OK	none	ApiResponseListString

GET getArticleListByPage

GET /article/all

请求参数

名称	位置	类型	必选	说明
page	query	integer	是	none
pageSize	query	integer	是	none

返回示例

{
  "code": 0,
  "msg": "",
  "data": [
    {
      "id": "",
      "title": "",
      "shortUrl": "",
      "authorName": "",
      "summary": "",
      "avatar": "",
      "cover": "",
      "views": 0,
      "categoryName": "",
      "tags": "",
      "likes": 0,
      "comments": 0,
      "isTop": false
    }
  ]
}

返回结果

状态码	状态码含义	说明	数据模型
200	OK	none	ApiResponseListArticlePreview

GET getLastFiveArticles

GET /article/lastFive

返回示例

{
  "code": 0,
  "msg": "",
  "data": [
    {
      "id": "",
      "title": "",
      "shortUrl": "",
      "authorName": "",
      "summary": "",
      "avatar": "",
      "cover": "",
      "views": 0,
      "categoryName": "",
      "tags": "",
      "likes": 0,
      "comments": 0,
      "isTop": false
    }
  ]
}

返回结果

状态码	状态码含义	说明	数据模型
200	OK	none	ApiResponseListArticlePreview

GET getRecommendArticles

GET /article/recommend/

请求参数

名称	位置	类型	必选	说明
shortUrl	path	string	是	none

返回示例

{
  "code": 0,
  "msg": "",
  "data": [
    {
      "id": "",
      "title": "",
      "shortUrl": "",
      "authorName": "",
      "summary": "",
      "avatar": "",
      "cover": "",
      "views": 0,
      "categoryName": "",
      "tags": "",
      "likes": 0,
      "comments": 0,
      "isTop": false
    }
  ]
}

返回结果

状态码	状态码含义	说明	数据模型
200	OK	none	ApiResponseListArticlePreview

GET getArticleListByCategory

GET /article/category/

请求参数

名称	位置	类型	必选	说明
shortUrl	path	string	是	none
page	query	integer	是	none
pageSize	query	integer	是	none

返回示例

{
  "code": 0,
  "msg": "",
  "data": [
    {
      "id": "",
      "title": "",
      "shortUrl": "",
      "authorName": "",
      "summary": "",
      "avatar": "",
      "cover": "",
      "views": 0,
      "categoryName": "",
      "tags": "",
      "likes": 0,
      "comments": 0,
      "isTop": false
    }
  ]
}

返回结果

状态码	状态码含义	说明	数据模型
200	OK	none	ApiResponseListArticlePreview

GET viewOneArticleApi

GET /article/

请求参数

名称	位置	类型	必选	说明
shortUrl	path	string	是	none

返回示例

{
  "code": 0,
  "msg": "",
  "data": {
    "shortUrl": "",
    "title": "",
    "content": "",
    "summary": "",
    "toc": "",
    "authorName": "",
    "cover": "",
    "categoryName": "",
    "tags": "",
    "views": 0,
    "likes": 0,
    "comments": 0
  }
}

返回结果

状态码	状态码含义	说明	数据模型
200	OK	none	ApiResponseArticleView

验证码控制器

GET getCaptcha

GET /captcha

返回示例

200 Response

返回结果

状态码	状态码含义	说明	数据模型
200	OK	none	Inline

返回数据结构

评论控制器

GET listCommentByArticleId

GET /comment/article/

请求参数

名称	位置	类型	必选	说明
shortUrl	path	string	是	none

返回示例

{
  "code": 0,
  "msg": "",
  "data": [
    {
      "id": "",
      "articleId": "",
      "content": "",
      "avatarUrl": "",
      "userName": "",
      "location": "",
      "website": "",
      "createdAt": "",
      "updatedAt": "",
      "parentId": "",
      "children": [
        {
          "id": "",
          "articleId": "",
          "content": "",
          "avatarUrl": "",
          "userName": "",
          "location": "",
          "website": "",
          "createdAt": "",
          "updatedAt": "",
          "parentId": "",
          "children": []
        }
      ]
    }
  ]
}

返回结果

状态码	状态码含义	说明	数据模型
200	OK	none	ApiResponseListCommentVO

GET getCommentListById

GET /comment/

请求参数

名称	位置	类型	必选	说明
id	path	string	是	none
page	query	integer	是	none
pageSize	query	integer	是	none

返回示例

{
  "code": 0,
  "msg": "",
  "data": [
    {
      "id": "",
      "areaId": "",
      "content": "",
      "avatarUrl": "",
      "userName": "",
      "location": "",
      "website": "",
      "createdAt": "",
      "updatedAt": "",
      "parentId": "",
      "parentUserName": "",
      "children": [
        {
          "id": "",
          "areaId": "",
          "content": "",
          "avatarUrl": "",
          "userName": "",
          "location": "",
          "website": "",
          "createdAt": "",
          "updatedAt": "",
          "parentId": "",
          "parentUserName": "",
          "children": []
        }
      ]
    }
  ]
}

返回结果

状态码	状态码含义	说明	数据模型
200	OK	none	ApiResponseListCommentVO

POST addNewComment

POST /comment

Body 请求参数

{
  "areaId": "string",
  "content": "string",
  "userName": "string",
  "email": "string",
  "website": "string",
  "parentId": "string"
}

请求参数

名称	位置	类型	必选	说明
body	body	CommentNotLoginForm	否	none

返回示例

{
  "code": 0,
  "msg": "",
  "data": {
    "id": "",
    "articleId": "",
    "content": "",
    "avatarUrl": "",
    "userName": "",
    "location": "",
    "website": "",
    "createdAt": "",
    "updatedAt": "",
    "parentId": "",
    "children": [
      {
        "id": "",
        "articleId": "",
        "content": "",
        "avatarUrl": "",
        "userName": "",
        "location": "",
        "website": "",
        "createdAt": "",
        "updatedAt": "",
        "parentId": "",
        "children": [
          {}
        ]
      }
    ]
  }
}

返回结果

状态码	状态码含义	说明	数据模型
200	OK	none	ApiResponseCommentVO

POST addNewCommentLogin

POST /comment/add

Body 请求参数

{
  "areaId": "string",
  "content": "string",
  "parentId": "string"
}

请求参数

名称	位置	类型	必选	说明
body	body	CommentLoginForm	否	none

返回示例

{
  "code": 0,
  "msg": "",
  "data": {
    "id": "",
    "areaId": "",
    "content": "",
    "avatarUrl": "",
    "userName": "",
    "location": "",
    "website": "",
    "platform": "",
    "browser": "",
    "createdAt": "",
    "updatedAt": "",
    "parentId": "",
    "parentUserName": "",
    "children": [
      {
        "id": "",
        "areaId": "",
        "content": "",
        "avatarUrl": "",
        "userName": "",
        "location": "",
        "website": "",
        "platform": "",
        "browser": "",
        "createdAt": "",
        "updatedAt": "",
        "parentId": "",
        "parentUserName": "",
        "children": [
          {}
        ]
      }
    ]
  }
}

返回结果

状态码	状态码含义	说明	数据模型
200	OK	none	ApiResponseCommentVO

导航菜单控制器

GET getNavMenu

GET /nav

返回示例

{
  "code": 0,
  "msg": "",
  "data": [
    {
      "name": "",
      "href": "",
      "children": [
        {
          "name": "",
          "href": "",
          "children": []
        }
      ]
    }
  ]
}

返回结果

状态码	状态码含义	说明	数据模型
200	OK	none	ApiResponseListNavMenuVO

分类控制器

GET getAllCategories

GET /category/all

返回示例

{
  "code": 0,
  "msg": "",
  "data": [
    {
      "id": "",
      "name": "",
      "shortUrl": ""
    }
  ]
}

返回结果

状态码	状态码含义	说明	数据模型
200	OK	none	ApiResponseListCategoryVO

记录更新控制器

GET getLastStatusUpdate

GET /statusUpdate/last

返回示例

{
  "code": 0,
  "msg": "",
  "data": {
    "shortUrl": "",
    "authorName": "",
    "images": [
      ""
    ],
    "title": "",
    "summary": "",
    "views": 0,
    "comments": 0,
    "likes": 0,
    "createdAt": "",
    "updatedAt": ""
  }
}

返回结果

状态码	状态码含义	说明	数据模型
200	OK	none	ApiResponseStatusUpdatePreview

GET getLastFourStatusUpdates

GET /statusUpdate/lastFour

返回示例

{
  "code": 0,
  "msg": "",
  "data": [
    {
      "shortUrl": "",
      "authorName": "",
      "images": [
        ""
      ],
      "title": "",
      "summary": "",
      "views": 0,
      "comments": 0,
      "likes": 0,
      "createdAt": "",
      "updatedAt": ""
    }
  ]
}

返回结果

状态码	状态码含义	说明	数据模型
200	OK	none	ApiResponseListStatusUpdatePreview

GET getAllStatusUpdates

GET /statusUpdate/all

请求参数

名称	位置	类型	必选	说明
page	query	integer	是	none
pageSize	query	integer	是	none

返回示例

{
  "code": 0,
  "msg": "",
  "data": [
    {
      "shortUrl": "",
      "authorName": "",
      "images": [
        ""
      ],
      "title": "",
      "summary": "",
      "views": 0,
      "comments": 0,
      "likes": 0,
      "createdAt": "",
      "updatedAt": ""
    }
  ]
}

返回结果

状态码	状态码含义	说明	数据模型
200	OK	none	ApiResponseListStatusUpdatePreview

GET getAllStatusUpdateShortLinksApi

GET /statusUpdate/shortLinks

返回示例

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

返回结果

状态码	状态码含义	说明	数据模型
200	OK	none	ApiResponseListString

GET getStatusUpdatesByCategory

GET /statusUpdate/category/

请求参数

名称	位置	类型	必选	说明
shortUrl	path	string	是	none
page	query	integer	是	none
pageSize	query	integer	是	none

返回示例

{
  "code": 0,
  "msg": "",
  "data": [
    {
      "shortUrl": "",
      "authorName": "",
      "images": [
        ""
      ],
      "title": "",
      "summary": "",
      "views": 0,
      "comments": 0,
      "likes": 0,
      "createdAt": "",
      "updatedAt": ""
    }
  ]
}

返回结果

状态码	状态码含义	说明	数据模型
200	OK	none	ApiResponseListStatusUpdatePreview

GET viewOneStatusUpdate

GET /statusUpdate/

请求参数

名称	位置	类型	必选	说明
shortUrl	path	string	是	none

返回示例

{
  "code": 0,
  "msg": "",
  "data": {
    "shortUrl": "",
    "authorName": "",
    "images": [
      ""
    ],
    "title": "",
    "summary": "",
    "views": 0,
    "comments": 0,
    "likes": 0,
    "createdAt": "",
    "updatedAt": ""
  }
}

返回结果

状态码	状态码含义	说明	数据模型
200	OK	none	ApiResponseStatusUpdateView

GET getWebsiteInfo

GET /websiteInfo

返回示例

{
  "": ""
}

返回结果

状态码	状态码含义	说明	数据模型
200	OK	none	ApiResponseMapString

PageController

GET getShortLinksApi

GET /page/shortLinks

返回示例

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

返回结果

状态码	状态码含义	说明	数据模型
200	OK	none	Inline

返回数据结构

GET getPageContentApi

GET /page/

请求参数

名称	位置	类型	必选	说明
refPath	path	string	是	none

返回示例

{
  "code": 0,
  "msg": "",
  "data": {
    "id": "",
    "title": "",
    "description": "",
    "refPath": "",
    "toc": "",
    "content": "",
    "views": 0,
    "likes": 0,
    "comments": 0,
    "commentId": "",
    "enable": false,
    "canDelete": false,
    "createdAt": "",
    "updatedAt": ""
  }
}

返回结果

状态码	状态码含义	说明	数据模型
200	OK	none	ApiResponsePageVO

SearchController

GET search

GET /search

请求参数

名称	位置	类型	必选	说明
keyword	query	string	是	none

返回示例

{
  "code": 0,
  "msg": "",
  "data": {
    "pages": [
      {
        "id": 0,
        "title": "",
        "description": "",
        "content": "",
        "shortUrl": "",
        "highlightedContent": ""
      }
    ],
    "articles": [
      {
        "id": 0,
        "title": "",
        "summary": "",
        "content": "",
        "shortUrl": "",
        "highlightedContent": ""
      }
    ],
    "moments": [
      {
        "id": 0,
        "title": "",
        "summary": "",
        "content": "",
        "shortUrl": "",
        "highlightedContent": ""
      }
    ]
  }
}

返回结果

状态码	状态码含义	说明	数据模型
200	OK	none	ApiResponseAggregatedSearchResult

PageViewController

GET getPageViews

GET /page-view

返回示例

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

返回结果

状态码	状态码含义	说明	数据模型
200	OK	none	ApiResponseListMapObject

UploadFileController

POST handleFileUpload

POST /upload

Body 请求参数

file: string

请求参数

名称	位置	类型	必选	说明
body	body	object	否	none
» file	body	string(binary)	是	none

返回示例

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

返回结果

状态码	状态码含义	说明	数据模型
200	OK	none	ApiResponseString

数据模型

Tag

{
  "id": 0,
  "name": "string",
  "createdAt": "string",
  "updatedAt": "string",
  "deletedAt": "string"
}

属性

名称	类型	必选	约束	中文名	说明
id	integer	false	none		标签ID，会由雪花算法生成
name	string	false	none		标签名称
createdAt	string	false	none		标签创建时间
updatedAt	string	false	none		标签更新时间
deletedAt	string	false	none		标签删除时间（软删除），如果不为空则表示已删除

MapString

{
  "key": "string"
}

属性

名称	类型	必选	约束	中文名	说明
key	string	false	none		none

ApiResponseTag

{
  "code": 0,
  "msg": "string",
  "data": {
    "id": 0,
    "name": "string",
    "createdAt": "string",
    "updatedAt": "string",
    "deletedAt": "string"
  }
}

属性

名称	类型	必选	约束	中文名	说明
code	integer	false	none		none
msg	string	false	none		none
data	Tag	false	none		none

TagVO

{
  "tagId": "string",
  "tagName": "string",
  "articleCount": 0
}

属性

名称	类型	必选	约束	中文名	说明
tagId	string	false	none		none
tagName	string	false	none		none
articleCount	integer	false	none		none

ApiResponseListTagVO

{
  "code": 0,
  "msg": "string",
  "data": [
    {
      "tagId": "string",
      "tagName": "string",
      "articleCount": 0
    }
  ]
}

属性

名称	类型	必选	约束	中文名	说明
code	integer	false	none		none
msg	string	false	none		none
data	[TagVO]	false	none		none

Object

{}

属性

None

StatusUpdateView

{
  "shortUrl": "string",
  "authorName": "string",
  "authorAvatar": "string",
  "categoryName": "string",
  "images": [
    "string"
  ],
  "title": "string",
  "content": "string",
  "views": 0,
  "comments": 0,
  "likes": 0,
  "commentId": "string",
  "isTop": true,
  "isHot": true,
  "isOriginal": true,
  "createdAt": "string",
  "updatedAt": "string"
}

属性

名称	类型	必选	约束	中文名	说明
shortUrl	string	false	none		说说短链接
authorName	string	false	none		作者名字
authorAvatar	string	false	none		作者头像
categoryName	string	false	none		none
images	[string]	false	none		图片
title	string	false	none		说说标题
content	string	false	none		内容（Markdown 格式，由前端解析）
views	integer	false	none		查看次数
comments	integer	false	none		评论次数
likes	integer	false	none		点赞次数
commentId	string	false	none		评论区 id
isTop	boolean	false	none		是否置顶
isHot	boolean	false	none		是否热门
isOriginal	boolean	false	none		是否原创
createdAt	string	false	none		说说创建时间
updatedAt	string	false	none		说说更新时间

ApiResponseString[]

{
  "code": 0,
  "msg": "string",
  "data": [
    "string"
  ]
}

属性

名称	类型	必选	约束	中文名	说明
code	integer	false	none		none
msg	string	false	none		none
data	[string]	false	none		none

ApiResponseObject

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

属性

名称	类型	必选	约束	中文名	说明
code	integer	false	none		none
msg	string	false	none		none
data	Object	false	none		none

ApiResponseStatusUpdateView

{
  "code": 0,
  "msg": "string",
  "data": {
    "shortUrl": "string",
    "authorName": "string",
    "authorAvatar": "string",
    "categoryName": "string",
    "images": [
      "string"
    ],
    "title": "string",
    "content": "string",
    "views": 0,
    "comments": 0,
    "likes": 0,
    "commentId": "string",
    "isTop": true,
    "isHot": true,
    "isOriginal": true,
    "createdAt": "string",
    "updatedAt": "string"
  }
}

属性

名称	类型	必选	约束	中文名	说明
code	integer	false	none		none
msg	string	false	none		none
data	StatusUpdateView	false	none		none

ApiResponseString

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

属性

名称	类型	必选	约束	中文名	说明
code	integer	false	none		none
msg	string	false	none		none
data	string	false	none		none

UserVO

{
  "id": "string",
  "nickname": "string",
  "email": "string",
  "avatar": "string",
  "createdAt": "string",
  "oauthProvider": "string"
}

属性

名称	类型	必选	约束	中文名	说明
id	string	false	none		none
nickname	string	false	none		none
email	string	false	none		none
avatar	string	false	none		none
createdAt	string	false	none		none
oauthProvider	string	false	none		none

ApiResponseUserVO

{
  "code": 0,
  "msg": "string",
  "data": {
    "id": "string",
    "nickname": "string",
    "email": "string",
    "avatar": "string",
    "createdAt": "string",
    "oauthProvider": "string"
  }
}

属性

名称	类型	必选	约束	中文名	说明
code	integer	false	none		none
msg	string	false	none		none
data	UserVO	false	none		none

UserRegisterDTO

{
  "nickname": "string",
  "email": "string",
  "password": "string"
}

属性

名称	类型	必选	约束	中文名	说明
nickname	string	false	none		none
email	string	false	none		none
password	string	false	none		none

ArticleVO

{
  "id": "string",
  "title": "string",
  "summary": "string",
  "toc": "string",
  "content": "string",
  "author": "string",
  "cover": "string",
  "categoryId": "string",
  "tags": "string",
  "views": 0,
  "likes": 0,
  "comments": 0,
  "shortUrl": "string",
  "isPublished": true,
  "createdAt": "string",
  "updatedAt": "string",
  "deletedAt": "string",
  "isTop": true,
  "isHot": true,
  "isOriginal": true
}

属性

名称	类型	必选	约束	中文名	说明
id	string	false	none		none
title	string	false	none		none
summary	string	false	none		none
toc	string	false	none		none
content	string	false	none		none
author	string	false	none		none
cover	string	false	none		none
categoryId	string	false	none		none
tags	string	false	none		none
views	integer	false	none		none
likes	integer	false	none		none
comments	integer	false	none		none
shortUrl	string	false	none		none
isPublished	boolean	false	none		none
createdAt	string	false	none		none
updatedAt	string	false	none		none
deletedAt	string	false	none		none
isTop	boolean	false	none		none
isHot	boolean	false	none		none
isOriginal	boolean	false	none		none

ApiResponseArticleVO

{
  "code": 0,
  "msg": "string",
  "data": {
    "id": "string",
    "title": "string",
    "summary": "string",
    "toc": "string",
    "content": "string",
    "author": "string",
    "cover": "string",
    "categoryId": "string",
    "tags": "string",
    "views": 0,
    "likes": 0,
    "comments": 0,
    "shortUrl": "string",
    "isPublished": true,
    "createdAt": "string",
    "updatedAt": "string",
    "deletedAt": "string",
    "isTop": true,
    "isHot": true,
    "isOriginal": true
  }
}

属性

名称	类型	必选	约束	中文名	说明
code	integer	false	none		none
msg	string	false	none		none
data	ArticleVO	false	none		none

ArticleDTO

{
  "title": "string",
  "content": "string",
  "cover": "string",
  "categoryId": "string",
  "tags": "string",
  "isPublished": true,
  "shortUrl": "string",
  "isTop": true,
  "isHot": true,
  "isOriginal": true
}

属性

名称	类型	必选	约束	中文名	说明
title	string	false	none		none
content	string	false	none		none
cover	string	false	none		none
categoryId	string	false	none		none
tags	string	false	none		none
isPublished	boolean	false	none		none
shortUrl	string	false	none		none
isTop	boolean	false	none		none
isHot	boolean	false	none		none
isOriginal	boolean	false	none		none

StatusUpdateVO

{
  "id": "string",
  "title": "string",
  "summary": "string",
  "content": "string",
  "authorName": "string",
  "img": "string",
  "categoryId": "string",
  "views": 0,
  "likes": 0,
  "comments": 0,
  "shortUrl": "string",
  "isPublished": true,
  "createdAt": "string",
  "updatedAt": "string",
  "deletedAt": "string",
  "isTop": true,
  "isHot": true,
  "isOriginal": true
}

属性

名称	类型	必选	约束	中文名	说明
id	string	false	none		分享 ID，会由雪花算法生成
title	string	false	none		分享标题
summary	string	false	none		分享摘要
content	string	false	none		分享内容，markdown 格式，交由前端解析
authorName	string	false	none		作者 ID，逻辑限制
img	string	false	none		分享图片，多个图片用逗号分隔
categoryId	string	false	none		分类 ID
views	integer	false	none		分享浏览量
likes	integer	false	none		分享点赞量
comments	integer	false	none		分享评论量
shortUrl	string	false	none		分享短链接
isPublished	boolean	false	none		是否发布（0：否，1：是）
createdAt	string	false	none		分享创建时间
updatedAt	string	false	none		分享更新时间
deletedAt	string	false	none		分享删除时间（软删除），如果不为空则表示已删除
isTop	boolean	false	none		是否置顶（0：否，1：是）
isHot	boolean	false	none		是否热门（0：否，1：是）
isOriginal	boolean	false	none		是否原创（0：否，1：是）

CategoryVO

{
  "id": "string",
  "name": "string",
  "shortUrl": "string",
  "isArticle": true
}

属性

名称	类型	必选	约束	中文名	说明
id	string	false	none		none
name	string	false	none		none
shortUrl	string	false	none		none
isArticle	boolean	false	none		none

ApiResponseListStatusUpdateVO

{
  "code": 0,
  "msg": "string",
  "data": [
    {
      "id": "string",
      "title": "string",
      "summary": "string",
      "content": "string",
      "authorName": "string",
      "img": "string",
      "categoryId": "string",
      "views": 0,
      "likes": 0,
      "comments": 0,
      "shortUrl": "string",
      "isPublished": true,
      "createdAt": "string",
      "updatedAt": "string",
      "deletedAt": "string",
      "isTop": true,
      "isHot": true,
      "isOriginal": true
    }
  ]
}

属性

名称	类型	必选	约束	中文名	说明
code	integer	false	none		none
msg	string	false	none		none
data	[StatusUpdateVO]	false	none		none

ApiResponseListCategoryVO

{
  "code": 0,
  "msg": "string",
  "data": [
    {
      "id": "string",
      "name": "string",
      "shortUrl": "string",
      "isArticle": true
    }
  ]
}

属性

名称	类型	必选	约束	中文名	说明
code	integer	false	none		none
msg	string	false	none		none
data	[CategoryVO]	false	none		none

ApiResponseStatusUpdateVO

{
  "code": 0,
  "msg": "string",
  "data": {
    "id": "string",
    "title": "string",
    "summary": "string",
    "content": "string",
    "authorName": "string",
    "img": "string",
    "categoryId": "string",
    "views": 0,
    "likes": 0,
    "comments": 0,
    "shortUrl": "string",
    "isPublished": true,
    "createdAt": "string",
    "updatedAt": "string",
    "deletedAt": "string",
    "isTop": true,
    "isHot": true,
    "isOriginal": true
  }
}

属性

名称	类型	必选	约束	中文名	说明
code	integer	false	none		none
msg	string	false	none		none
data	StatusUpdateVO	false	none		none

ApiResponseCategoryVO

{
  "code": 0,
  "msg": "string",
  "data": {
    "id": "string",
    "name": "string",
    "shortUrl": "string",
    "isArticle": true
  }
}

属性

名称	类型	必选	约束	中文名	说明
code	integer	false	none		none
msg	string	false	none		none
data	CategoryVO	false	none		none

StatusUpdateDTO

{
  "title": "string",
  "summary": "string",
  "content": "string",
  "img": "string",
  "categoryId": "string",
  "shortUrl": "string",
  "isPublished": true,
  "isTop": true,
  "isHot": true,
  "isOriginal": true
}

属性

名称	类型	必选	约束	中文名	说明
title	string	false	none		分享标题
summary	string	false	none		分享摘要
content	string	false	none		分享内容，markdown 格式，交由前端解析
img	string	false	none		分享图片，多个图片用逗号分隔
categoryId	string	false	none		分类 ID
shortUrl	string	false	none		分享短链接
isPublished	boolean	false	none		是否发布（0：否，1：是）
isTop	boolean	false	none		是否置顶（0：否，1：是）
isHot	boolean	false	none		是否热门（0：否，1：是）
isOriginal	boolean	false	none		是否原创（0：否，1：是）

AddCategory

{
  "name": "string",
  "shortUrl": "string",
  "type": true
}

属性

名称	类型	必选	约束	中文名	说明
name	string	false	none		none
shortUrl	string	false	none		none
type	boolean	false	none		none

PageVO

{
  "id": "string",
  "title": "string",
  "description": "string",
  "refPath": "string",
  "toc": "string",
  "content": "string",
  "views": 0,
  "likes": 0,
  "comments": 0,
  "commentId": "string",
  "enable": true,
  "canDelete": true,
  "createdAt": "string",
  "updatedAt": "string"
}

属性

名称	类型	必选	约束	中文名	说明
id	string	false	none		none
title	string	false	none		none
description	string	false	none		none
refPath	string	false	none		none
toc	string	false	none		none
content	string	false	none		none
views	integer	false	none		none
likes	integer	false	none		none
comments	integer	false	none		none
commentId	string	false	none		none
enable	boolean	false	none		none
canDelete	boolean	false	none		none
createdAt	string	false	none		none
updatedAt	string	false	none		none

ApiResponseListArticleVO

{
  "code": 0,
  "msg": "string",
  "data": [
    {
      "id": "string",
      "title": "string",
      "summary": "string",
      "toc": "string",
      "content": "string",
      "author": "string",
      "cover": "string",
      "categoryId": "string",
      "tags": "string",
      "views": 0,
      "likes": 0,
      "comments": 0,
      "shortUrl": "string",
      "isPublished": true,
      "createdAt": "string",
      "updatedAt": "string",
      "deletedAt": "string",
      "isTop": true,
      "isHot": true,
      "isOriginal": true
    }
  ]
}

属性

名称	类型	必选	约束	中文名	说明
code	integer	false	none		none
msg	string	false	none		none
data	[ArticleVO]	false	none		none

ApiResponsePageVO

{
  "code": 0,
  "msg": "string",
  "data": {
    "id": "string",
    "title": "string",
    "description": "string",
    "refPath": "string",
    "toc": "string",
    "content": "string",
    "views": 0,
    "likes": 0,
    "comments": 0,
    "commentId": "string",
    "enable": true,
    "canDelete": true,
    "createdAt": "string",
    "updatedAt": "string"
  }
}

属性

名称	类型	必选	约束	中文名	说明
code	integer	false	none		none
msg	string	false	none		none
data	PageVO	false	none		none

ArchiveArticle

{
  "title": "string",
  "shortUrl": "string",
  "category": "string",
  "createdAt": "string"
}

属性

名称	类型	必选	约束	中文名	说明
title	string	false	none		none
shortUrl	string	false	none		none
category	string	false	none		none
createdAt	string	false	none		none

PageDTO

{
  "title": "string",
  "description": "string",
  "refPath": "string",
  "content": "string",
  "enable": true,
  "canComment": true
}

属性

名称	类型	必选	约束	中文名	说明
title	string	false	none		none
description	string	false	none		none
refPath	string	false	none		none
content	string	false	none		none
enable	boolean	false	none		none
canComment	boolean	false	none		none

ArchiveStatusUpdate

{
  "title": "string",
  "shortUrl": "string",
  "category": "string",
  "createdAt": "string"
}

属性

名称	类型	必选	约束	中文名	说明
title	string	false	none		none
shortUrl	string	false	none		none
category	string	false	none		none
createdAt	string	false	none		none

ApiResponseListPageVO

{
  "code": 0,
  "msg": "string",
  "data": [
    {
      "id": "string",
      "title": "string",
      "description": "string",
      "refPath": "string",
      "toc": "string",
      "content": "string",
      "views": 0,
      "likes": 0,
      "comments": 0,
      "commentId": "string",
      "enable": true,
      "canDelete": true,
      "createdAt": "string",
      "updatedAt": "string"
    }
  ]
}

属性

名称	类型	必选	约束	中文名	说明
code	integer	false	none		none
msg	string	false	none		none
data	[PageVO]	false	none		none

PostStatusToggle

{
  "isPublished": true,
  "isTop": true,
  "isHot": true,
  "isOriginal": true
}

属性

名称	类型	必选	约束	中文名	说明
isPublished	boolean	false	none		none
isTop	boolean	false	none		none
isHot	boolean	false	none		none
isOriginal	boolean	false	none		none

{year=0, @required={year=false}, @class={year=int}, @comment={year=}}

{
  "articleCount": 0,
  "statusUpdateCount": 0,
  "articles": "new ArrayList<>()",
  "statusUpdates": "new ArrayList<>()"
}

属性

名称	类型	必选	约束	中文名	说明
articleCount	integer	false	none		none
statusUpdateCount	integer	false	none		none
articles	[ArchiveArticle]	false	none		none
statusUpdates	[ArchiveStatusUpdate]	false	none		none

MapArchiveSummary

{
  "{year=0, @required={year=false}, @class={year=int}, @comment={year=}}": {
    "articleCount": 0,
    "statusUpdateCount": 0,
    "articles": "new ArrayList<>()",
    "statusUpdates": "new ArrayList<>()"
  }
}

属性

名称	类型	必选	约束	中文名	说明
{year=0, @required={year=false}, @class={year=int}, @comment={year=}}	{year=0, @required={year=false}, @class={year=int}, @comment={year=}}	false	none		none

ApiResponseMapArchiveSummary

{
  "code": 0,
  "msg": "string",
  "data": {
    "{year=0, @required={year=false}, @class={year=int}, @comment={year=}}": {
      "articleCount": 0,
      "statusUpdateCount": 0,
      "articles": "new ArrayList<>()",
      "statusUpdates": "new ArrayList<>()"
    }
  }
}

属性

名称	类型	必选	约束	中文名	说明
code	integer	false	none		none
msg	string	false	none		none
data	MapArchiveSummary	false	none		none

ApiResponseListString

{
  "code": 0,
  "msg": "string",
  "data": [
    "string"
  ]
}

属性

名称	类型	必选	约束	中文名	说明
code	integer	false	none		none
msg	string	false	none		none
data	[string]	false	none		none

ArticlePreview

{
  "id": "string",
  "title": "string",
  "shortUrl": "string",
  "authorName": "string",
  "summary": "string",
  "avatar": "string",
  "cover": "string",
  "views": 0,
  "categoryName": "string",
  "tags": "string",
  "likes": 0,
  "comments": 0,
  "isTop": true
}

属性

名称	类型	必选	约束	中文名	说明
id	string	false	none		none
title	string	false	none		文章标题
shortUrl	string	false	none		文章短链接
authorName	string	false	none		作者名字
summary	string	false	none		文章简介
avatar	string	false	none		作者头像
cover	string	false	none		文章封面
views	integer	false	none		文章浏览量
categoryName	string	false	none		文章分类名称
tags	string	false	none		文章标签
likes	integer	false	none		文章点赞量
comments	integer	false	none		文章评论量
isTop	boolean	false	none		是否置顶

ApiResponseListArticlePreview

{
  "code": 0,
  "msg": "string",
  "data": [
    {
      "id": "string",
      "title": "string",
      "shortUrl": "string",
      "authorName": "string",
      "summary": "string",
      "avatar": "string",
      "cover": "string",
      "views": 0,
      "categoryName": "string",
      "tags": "string",
      "likes": 0,
      "comments": 0,
      "isTop": true
    }
  ]
}

属性

名称	类型	必选	约束	中文名	说明
code	integer	false	none		none
msg	string	false	none		none
data	[ArticlePreview]	false	none		none

ArticleView

{
  "shortUrl": "string",
  "title": "string",
  "content": "string",
  "summary": "string",
  "toc": "string",
  "authorName": "string",
  "cover": "string",
  "categoryName": "string",
  "tags": "string",
  "views": 0,
  "likes": 0,
  "comments": 0,
  "commentId": "string"
}

属性

名称	类型	必选	约束	中文名	说明
shortUrl	string	false	none		文章短链接
title	string	false	none		文章标题
content	string	false	none		文章内容，markdown 格式，交由前端解析
summary	string	false	none		文章摘要
toc	string	false	none		文章目录
authorName	string	false	none		作者名字
cover	string	false	none		文章封面
categoryName	string	false	none		文章分类名称
tags	string	false	none		文章标签
views	integer	false	none		文章浏览量
likes	integer	false	none		文章点赞量
comments	integer	false	none		文章评论量
commentId	string	false	none		挂载评论区id

ApiResponseArticleView

{
  "code": 0,
  "msg": "string",
  "data": {
    "shortUrl": "string",
    "title": "string",
    "content": "string",
    "summary": "string",
    "toc": "string",
    "authorName": "string",
    "cover": "string",
    "categoryName": "string",
    "tags": "string",
    "views": 0,
    "likes": 0,
    "comments": 0,
    "commentId": "string"
  }
}

属性

名称	类型	必选	约束	中文名	说明
code	integer	false	none		none
msg	string	false	none		none
data	ArticleView	false	none		none

CommentVO

{
  "id": "string",
  "areaId": "string",
  "content": "string",
  "avatarUrl": "string",
  "userName": "string",
  "location": "string",
  "website": "string",
  "platform": "string",
  "browser": "string",
  "createdAt": "string",
  "updatedAt": "string",
  "parentId": "string",
  "parentUserName": "string",
  "children": "new ArrayList<>()"
}

属性

名称	类型	必选	约束	中文名	说明
id	string	false	none		none
areaId	string	false	none		评论区 id
content	string	false	none		评论内容（markdown 格式）
avatarUrl	string	false	none		评论者头像
userName	string	false	none		评论者昵称
location	string	false	none		评论者归属地
website	string	false	none		评论者网站
platform	string	false	none		评论者操作系统
browser	string	false	none		评论者浏览器
createdAt	string	false	none		评论创建时间
updatedAt	string	false	none		评论更新时间
parentId	string	false	none		none
parentUserName	string	false	none		none
children	[CommentVO]	false	none		查看时候存储子评论，而存储时候存储父评论 id

HighlightedPageDocument

{
  "id": 0,
  "title": "string",
  "description": "string",
  "content": "string",
  "shortUrl": "string",
  "highlightedContent": "string"
}

属性

名称	类型	必选	约束	中文名	说明
id	integer	false	none		none
title	string	false	none		none
description	string	false	none		none
content	string	false	none		none
shortUrl	string	false	none		none
highlightedContent	string	false	none		none

ApiResponseListCommentVO

{
  "code": 0,
  "msg": "string",
  "data": [
    {
      "id": "string",
      "areaId": "string",
      "content": "string",
      "avatarUrl": "string",
      "userName": "string",
      "location": "string",
      "website": "string",
      "platform": "string",
      "browser": "string",
      "createdAt": "string",
      "updatedAt": "string",
      "parentId": "string",
      "parentUserName": "string",
      "children": "new ArrayList<>()"
    }
  ]
}

属性

名称	类型	必选	约束	中文名	说明
code	integer	false	none		none
msg	string	false	none		none
data	[CommentVO]	false	none		none

HighlightedArticleDocument

{
  "id": 0,
  "title": "string",
  "summary": "string",
  "content": "string",
  "shortUrl": "string",
  "highlightedContent": "string"
}

属性

名称	类型	必选	约束	中文名	说明
id	integer	false	none		none
title	string	false	none		none
summary	string	false	none		none
content	string	false	none		none
shortUrl	string	false	none		none
highlightedContent	string	false	none		none

ApiResponseCommentVO

{
  "code": 0,
  "msg": "string",
  "data": {
    "id": "string",
    "areaId": "string",
    "content": "string",
    "avatarUrl": "string",
    "userName": "string",
    "location": "string",
    "website": "string",
    "platform": "string",
    "browser": "string",
    "createdAt": "string",
    "updatedAt": "string",
    "parentId": "string",
    "parentUserName": "string",
    "children": "new ArrayList<>()"
  }
}

属性

名称	类型	必选	约束	中文名	说明
code	integer	false	none		none
msg	string	false	none		none
data	CommentVO	false	none		none

HighlightedMomentDocument

{
  "id": 0,
  "title": "string",
  "summary": "string",
  "content": "string",
  "shortUrl": "string",
  "highlightedContent": "string"
}

属性

名称	类型	必选	约束	中文名	说明
id	integer	false	none		none
title	string	false	none		none
summary	string	false	none		none
content	string	false	none		none
shortUrl	string	false	none		none
highlightedContent	string	false	none		none

CommentNotLoginForm

{
  "areaId": "string",
  "content": "string",
  "userName": "string",
  "email": "string",
  "website": "string",
  "parentId": "string"
}

属性

名称	类型	必选	约束	中文名	说明
areaId	string	false	none		评论区 id
content	string	false	none		评论内容（markdown格式）
userName	string	false	none		评论者昵称
email	string	false	none		评论者邮箱
website	string	false	none		评论者网站
parentId	string	false	none		父评论ID，如果为空则表示是顶级评论，否则是回复评论

AggregatedSearchResult

{
  "pages": [
    {
      "id": 0,
      "title": "string",
      "description": "string",
      "content": "string",
      "shortUrl": "string",
      "highlightedContent": "string"
    }
  ],
  "articles": [
    {
      "id": 0,
      "title": "string",
      "summary": "string",
      "content": "string",
      "shortUrl": "string",
      "highlightedContent": "string"
    }
  ],
  "moments": [
    {
      "id": 0,
      "title": "string",
      "summary": "string",
      "content": "string",
      "shortUrl": "string",
      "highlightedContent": "string"
    }
  ]
}

属性

名称	类型	必选	约束	中文名	说明
pages	[HighlightedPageDocument]	false	none		none
articles	[HighlightedArticleDocument]	false	none		none
moments	[HighlightedMomentDocument]	false	none		none

NavMenuVO

{
  "name": "string",
  "isArticle": true,
  "href": "string",
  "children": [
    {
      "name": "string",
      "isArticle": true,
      "href": "string",
      "children": [
        {
          "name": "string",
          "isArticle": true,
          "href": "string",
          "children": [
            {}
          ]
        }
      ]
    }
  ]
}

属性

名称	类型	必选	约束	中文名	说明
name	string	false	none		none
isArticle	boolean	false	none		none
href	string	false	none		none
children	[NavMenuVO]	false	none		none

ApiResponseAggregatedSearchResult

{
  "code": 0,
  "msg": "string",
  "data": {
    "pages": [
      {
        "id": 0,
        "title": "string",
        "description": "string",
        "content": "string",
        "shortUrl": "string",
        "highlightedContent": "string"
      }
    ],
    "articles": [
      {
        "id": 0,
        "title": "string",
        "summary": "string",
        "content": "string",
        "shortUrl": "string",
        "highlightedContent": "string"
      }
    ],
    "moments": [
      {
        "id": 0,
        "title": "string",
        "summary": "string",
        "content": "string",
        "shortUrl": "string",
        "highlightedContent": "string"
      }
    ]
  }
}

属性

名称	类型	必选	约束	中文名	说明
code	integer	false	none		none
msg	string	false	none		none
data	AggregatedSearchResult	false	none		none

ApiResponseListNavMenuVO

{
  "code": 0,
  "msg": "string",
  "data": [
    {
      "name": "string",
      "isArticle": true,
      "href": "string",
      "children": [
        {
          "name": "string",
          "isArticle": true,
          "href": "string",
          "children": [
            {}
          ]
        }
      ]
    }
  ]
}

属性

名称	类型	必选	约束	中文名	说明
code	integer	false	none		none
msg	string	false	none		none
data	[NavMenuVO]	false	none		none

StatusUpdatePreview

{
  "shortUrl": "string",
  "authorName": "string",
  "authorAvatar": "string",
  "images": [
    "string"
  ],
  "title": "string",
  "summary": "string",
  "views": 0,
  "comments": 0,
  "likes": 0,
  "isTop": true,
  "isHot": true,
  "createdAt": "string",
  "updatedAt": "string"
}

属性

名称	类型	必选	约束	中文名	说明
shortUrl	string	false	none		说说短链接
authorName	string	false	none		作者名字
authorAvatar	string	false	none		作者头像
images	[string]	false	none		图片
title	string	false	none		说说标题
summary	string	false	none		说说摘要
views	integer	false	none		查看次数
comments	integer	false	none		评论次数
likes	integer	false	none		点赞次数
isTop	boolean	false	none		是否置顶
isHot	boolean	false	none		是否热门
createdAt	string	false	none		说说创建时间
updatedAt	string	false	none		说说更新时间

ApiResponseStatusUpdatePreview

{
  "code": 0,
  "msg": "string",
  "data": {
    "shortUrl": "string",
    "authorName": "string",
    "authorAvatar": "string",
    "images": [
      "string"
    ],
    "title": "string",
    "summary": "string",
    "views": 0,
    "comments": 0,
    "likes": 0,
    "isTop": true,
    "isHot": true,
    "createdAt": "string",
    "updatedAt": "string"
  }
}

属性

名称	类型	必选	约束	中文名	说明
code	integer	false	none		none
msg	string	false	none		none
data	StatusUpdatePreview	false	none		none

ApiResponseListStatusUpdatePreview

{
  "code": 0,
  "msg": "string",
  "data": [
    {
      "shortUrl": "string",
      "authorName": "string",
      "authorAvatar": "string",
      "images": [
        "string"
      ],
      "title": "string",
      "summary": "string",
      "views": 0,
      "comments": 0,
      "likes": 0,
      "isTop": true,
      "isHot": true,
      "createdAt": "string",
      "updatedAt": "string"
    }
  ]
}

属性

名称	类型	必选	约束	中文名	说明
code	integer	false	none		none
msg	string	false	none		none
data	[StatusUpdatePreview]	false	none		none

CommentLoginForm

{
  "areaId": "string",
  "content": "string",
  "parentId": "string"
}

属性

名称	类型	必选	约束	中文名	说明
areaId	string	false	none		评论区 id
content	string	false	none		评论内容（markdown 格式）
parentId	string	false	none		父评论 ID，如果为空则表示是顶级评论，否则是回复评论

key

{}

属性

None

MapObject

{
  "key": {}
}

属性

名称	类型	必选	约束	中文名	说明
key	key	false	none		none

ApiResponseListMapObject

{
  "code": 0,
  "msg": "string",
  "data": [
    {
      "key": {}
    }
  ]
}

属性

名称	类型	必选	约束	中文名	说明
code	integer	false	none		none
msg	string	false	none		none
data	[MapObject]	false	none		none

ApiResponseMapString

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

属性

名称	类型	必选	约束	中文名	说明
code	integer	false	none		none
msg	string	false	none		none
data	MapString	false	none		none