Skip to content

Latest commit

 

History

History
2577 lines (1953 loc) · 46.6 KB

api-doc.md

File metadata and controls

2577 lines (1953 loc) · 46.6 KB

XNote

简体中文 | English | api-doc

Base URLs:

Authentication

笔记相关接口

POST 增加笔记

POST /note

Body 请求参数

{
  "title": "string",
  "content": "string",
  "isPublic": "NO",
  "typeId": 1
}

请求参数

名称 位置 类型 必选 中文名 说明
Authorization header string 是 none
body body NoteAddForm 否 NoteAddForm none

返回示例

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

返回结果

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

返回数据结构

DELETE 批量删除笔记

DELETE /note

请求参数

名称 位置 类型 必选 中文名 说明
noteIds query array[string] 是 none
Authorization header string 是 none

返回示例

{
  "status": 0,
  "message": "",
  "data": null
}

返回结果

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

返回数据结构

PUT 更新笔记

PUT /note

Body 请求参数

{
  "id": 1,
  "title": "string",
  "content": "string",
  "isPublic": "NO",
  "typeId": 0
}

请求参数

名称 位置 类型 必选 中文名 说明
Authorization header string 是 none
body body NoteUpdateForm 否 none

返回示例

{
  "status": 0,
  "message": "",
  "data": null
}

返回结果

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

返回数据结构

PUT 批量更新笔记类型

PUT /note/types

Body 请求参数

{
  "noteIds": [
    0
  ],
  "typeId": 1
}

请求参数

名称 位置 类型 必选 中文名 说明
Authorization header string 是 none
body body NoteUpdateTypeForm 否 none

返回示例

{
  "status": 0,
  "message": "",
  "data": null
}

返回结果

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

返回数据结构

GET 查看笔记

GET /note/{noteId}

请求参数

名称 位置 类型 必选 中文名 说明
noteId path string 是 none
shareCode query string 否 none
Authorization header string 是 none

返回示例

{
  "status": 0,
  "message": "",
  "data": {
    "id": 0,
    "title": "",
    "content": "",
    "userId": 0,
    "releaseTime": "",
    "updateTime": "",
    "isPublic": "",
    "typeId": 0
  }
}

返回结果

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

返回数据结构

GET 搜索笔记

GET /note/search

请求参数

名称 位置 类型 必选 中文名 说明
current query integer 否 none
size query integer 否 none
search query string 否 none
heightLightPreTag query string 否 none
heightLightPostTag query string 否 none
Authorization header string 是 none

返回示例

{
  "status": 0,
  "message": "",
  "data": {
    "current": 0,
    "page": 0,
    "size": 0,
    "total": 0,
    "records": [
      {
        "id": 0,
        "title": "",
        "content": "",
        "userId": 0,
        "releaseTime": "",
        "updateTime": "",
        "isPublic": "",
        "typeId": 0
      }
    ]
  }
}

返回结果

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

返回数据结构

GET 搜索用户笔记

GET /note/search/{userId}

请求参数

名称 位置 类型 必选 中文名 说明
userId path string 是 none
current query integer 否 none
size query integer 否 none
search query string 否 none
typeId query integer 否 none
Authorization header string 是 none

返回示例

{
  "status": 0,
  "message": "",
  "data": {
    "current": 0,
    "page": 0,
    "size": 0,
    "total": 0,
    "records": [
      {
        "id": 0,
        "title": "",
        "userId": 0,
        "releaseTime": "",
        "isPublic": "",
        "updateTime": "",
        "typeId": 0
      }
    ]
  }
}

返回结果

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

返回数据结构

用户相关接口

POST 注册

POST /user/register

Body 请求参数

{
  "name": "string",
  "account": "string",
  "password": "string",
  "email": "string",
  "verificationCode": "string"
}

请求参数

名称 位置 类型 必选 中文名 说明
Authorization header string 是 none
body body UserRegisterForm 否 UserRegisterForm none

返回示例

{
  "status": 0,
  "message": "",
  "data": null
}

返回结果

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

返回数据结构

POST 登录

POST /user/login

Body 请求参数

{
  "account": "string",
  "password": "string"
}

请求参数

名称 位置 类型 必选 中文名 说明
Authorization header string 是 none
body body UserLoginForm 否 UserLoginForm none

返回示例

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

返回结果

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

返回数据结构

POST 注销

POST /user/logout

请求参数

名称 位置 类型 必选 中文名 说明
Authorization header string 是 none

返回示例

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

返回结果

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

返回数据结构

GET 根据id获取用户信息

GET /user/{userId}

请求参数

名称 位置 类型 必选 中文名 说明
userId path string 是 none
Authorization header string 是 none

返回示例

{
  "status": 0,
  "message": "",
  "data": {
    "id": 0,
    "name": "",
    "account": "",
    "email": "",
    "status": "",
    "homePageNoteId": 0,
    "imageStorageSize": 0
  }
}

返回结果

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

返回数据结构

GET 获取自己的用户信息

GET /user/me

请求参数

名称 位置 类型 必选 中文名 说明
Authorization header string 是 none

返回示例

{
  "status": 0,
  "message": "",
  "data": {
    "id": 0,
    "name": "",
    "account": "",
    "email": "",
    "status": "",
    "homePageNoteId": 0,
    "imageStorageSize": 0
  }
}

返回结果

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

返回数据结构

GET 刷新token

GET /user/new-token

请求参数

名称 位置 类型 必选 中文名 说明
Authorization header string 是 none

返回示例

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

返回结果

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

返回数据结构

PUT 更新用户信息

PUT /user

Body 请求参数

{
  "name": "string",
  "homePageNoteId": 1
}

请求参数

名称 位置 类型 必选 中文名 说明
Authorization header string 是 none
body body UserUpdateForm 否 UserUpdateForm none

返回示例

{
  "status": 0,
  "message": "",
  "data": null
}

返回结果

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

返回数据结构

PUT 更新密码

PUT /user/password

Body 请求参数

{
  "password": "string"
}

请求参数

名称 位置 类型 必选 中文名 说明
Authorization header string 是 none
body body UserUpdatePasswordForm 否 UserUpdatePasswordForm none

返回示例

{
  "status": 0,
  "message": "",
  "data": null
}

返回结果

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

返回数据结构

PUT 更新邮箱

PUT /user/email

Body 请求参数

{
  "email": "string",
  "verificationCode": "string"
}

请求参数

名称 位置 类型 必选 中文名 说明
Authorization header string 是 none
body body UserUpdateEmailForm 否 UserUpdateEmailForm none

返回示例

{
  "status": 0,
  "message": "",
  "data": null
}

返回结果

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

返回数据结构

图片相关接口

POST 上传图片

POST /image

Body 请求参数

uploadImageFile: string

请求参数

名称 位置 类型 必选 中文名 说明
Authorization header string 是 none
body body object 否 none
» uploadImageFile body string(binary) 是 none

返回示例

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

返回结果

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

返回数据结构

DELETE 删除图片

DELETE /image

请求参数

名称 位置 类型 必选 中文名 说明
userImageIds query array[string] 是 none
Authorization header string 是 none

返回示例

{
  "status": 0,
  "message": "",
  "data": null
}

返回结果

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

返回数据结构

GET 预览图片

GET /image/name/{imageName}

请求参数

名称 位置 类型 必选 中文名 说明
imageName path string 是 none
Authorization header string 是 none

返回示例

200 Response

{}

返回结果

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

返回数据结构

GET 搜索自己的图片

GET /image/me

请求参数

名称 位置 类型 必选 中文名 说明
page query integer 否 none
size query integer 否 none
search query string 否 none
Authorization header string 是 none

返回示例

{
  "status": 0,
  "message": "",
  "data": {
    "current": 0,
    "page": 0,
    "size": 0,
    "total": 0,
    "records": [
      {
        "id": 0,
        "userId": 0,
        "imageId": 0,
        "alias": "",
        "lastDownloadTime": ""
      }
    ]
  }
}

返回结果

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

返回数据结构

笔记分类相关接口

POST 添加笔记分类

POST /note-type

Body 请求参数

{
  "name": "string"
}

请求参数

名称 位置 类型 必选 中文名 说明
Authorization header string 是 none
body body NoteTypeAddForm 否 none

返回示例

{
  "status": 0,
  "message": "",
  "data": null
}

返回结果

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

返回数据结构

DELETE 删除笔记分类

DELETE /note-type

请求参数

名称 位置 类型 必选 中文名 说明
ids query array[string] 是 none
Authorization header string 是 none

返回示例

{
  "status": 0,
  "message": "",
  "data": null
}

返回结果

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

返回数据结构

PUT 修改笔记分类

PUT /note-type

Body 请求参数

{
  "id": 1,
  "name": "string"
}

请求参数

名称 位置 类型 必选 中文名 说明
Authorization header string 是 none
body body NoteTypeUpdateForm 否 none

返回示例

{
  "status": 0,
  "message": "",
  "data": null
}

返回结果

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

返回数据结构

GET 获取用户所有笔记分类

GET /note-type/user/{userId}

请求参数

名称 位置 类型 必选 中文名 说明
userId path string 是 none
Authorization header string 是 none

返回示例

{
  "status": 0,
  "message": "",
  "data": [
    {
      "id": 0,
      "name": "",
      "userId": 0
    }
  ]
}

返回结果

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

返回数据结构

请求错误相关接口

GET 请求路径不存在

GET /**

请求参数

名称 位置 类型 必选 中文名 说明
Authorization header string 是 none

返回示例

返回结果

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

返回数据结构

笔记分享记录相关接口

POST 分享笔记

POST /share-note-record

Body 请求参数

{
  "noteId": 1,
  "expireTime": "new Timestamp(System.currentTimeMillis() + 1000 * 3600 * 24 * 7)"
}

请求参数

名称 位置 类型 必选 中文名 说明
Authorization header string 是 none
body body ShareNoteRecordCreateForm 否 none

返回示例

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

返回结果

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

返回数据结构

DELETE 批量删除分享的记录

DELETE /share-note-record

请求参数

名称 位置 类型 必选 中文名 说明
shareNoteRecordIds query array[string] 是 none
Authorization header string 是 none

返回示例

{
  "status": 0,
  "message": "",
  "data": null
}

返回结果

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

返回数据结构

PUT 修改笔记分享记录

PUT /share-note-record

Body 请求参数

{
  "id": 0,
  "expireTime": "new Timestamp(System.currentTimeMillis() + 1000 * 3600 * 24 * 7)"
}

请求参数

名称 位置 类型 必选 中文名 说明
Authorization header string 是 none
body body ShareNoteRecordUpdateForm 否 none

返回示例

{
  "status": 0,
  "message": "",
  "data": null
}

返回结果

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

返回数据结构

GET 获取分享的记录

GET /share-note-record/me

请求参数

名称 位置 类型 必选 中文名 说明
current query integer 否 none
size query integer 否 none
Authorization header string 是 none

返回示例

{
  "status": 0,
  "message": "",
  "data": {
    "current": 0,
    "page": 0,
    "size": 0,
    "total": 0,
    "records": [
      {
        "id": 0,
        "code": "",
        "noteId": 0,
        "userId": 0,
        "expireTime": "",
        "title": ""
      }
    ]
  }
}

返回结果

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

返回数据结构

验证码相关接口

GET 发送验证码到邮箱

GET /verification-code/send/to-email

请求参数

名称 位置 类型 必选 中文名 说明
email query string 是 none
imageCode query string 是 none
Authorization header string 是 none

返回示例

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

返回结果

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

返回数据结构

GET 获取图片验证码的base64

GET /verification-code/image/base64

请求参数

名称 位置 类型 必选 中文名 说明
Authorization header string 是 none

返回示例

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

返回结果

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

返回数据结构

GET 获取图片验证码

GET /verification-code/image

请求参数

名称 位置 类型 必选 中文名 说明
Authorization header string 是 none

返回示例

200 Response

{}

返回结果

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

返回数据结构

数据模型

Result«User»

{
  "status": 0,
  "message": "string",
  "data": {
    "id": 0,
    "name": "string",
    "account": "string",
    "email": "string",
    "status": "DISABLE",
    "homePageNoteId": 0,
    "imageStorageSize": 0
  }
}

Result«User»

属性

名称 类型 必选 约束 中文名 说明
status integer¦null false none none
message string¦null false none none
data User false none none

User

{
  "id": 0,
  "name": "string",
  "account": "string",
  "email": "string",
  "status": "DISABLE",
  "homePageNoteId": 0,
  "imageStorageSize": 0
}

User

属性

名称 类型 必选 约束 中文名 说明
id integer¦null false none none
name string¦null false none none
account string¦null false none none
email string¦null false none none
status string¦null false none none
homePageNoteId integer¦null false none none
imageStorageSize integer¦null false none none

枚举值

属性 值
status DISABLE
status ENABLE

Note

{
  "id": 0,
  "title": "string",
  "content": "string",
  "userId": 0,
  "releaseTime": "string",
  "updateTime": "string",
  "isPublic": "NO",
  "typeId": 0
}

Note

属性

名称 类型 必选 约束 中文名 说明
id integer¦null false none none
title string¦null false none none
content string¦null false none none
userId integer¦null false none none
releaseTime string¦null false none none
updateTime string¦null false none none
isPublic string¦null false none none
typeId integer¦null false none none

枚举值

属性 值
isPublic NO
isPublic YES

Result«Note»

{
  "status": 0,
  "message": "string",
  "data": {
    "id": 0,
    "title": "string",
    "content": "string",
    "userId": 0,
    "releaseTime": "string",
    "updateTime": "string",
    "isPublic": "NO",
    "typeId": 0
  }
}

Result«Note»

属性

名称 类型 必选 约束 中文名 说明
status integer¦null false none none
message string¦null false none none
data Note false none none

Image

{
  "id": 0,
  "userId": 0,
  "alias": "string",
  "name": "string",
  "uploadTime": "string",
  "url": "string",
  "size": 0
}

Image

属性

名称 类型 必选 约束 中文名 说明
id integer¦null false none none
userId integer¦null false none none
alias string¦null false none none
name string¦null false none none
uploadTime string¦null false none none
url string¦null false none none
size integer¦null false none none

NoteType

{
  "id": 0,
  "name": "string",
  "userId": 0
}

NoteType

属性

名称 类型 必选 约束 中文名 说明
id integer¦null false none none
name string¦null false none none
userId integer¦null false none none

Result«List«NoteType»»

{
  "status": 0,
  "message": "string",
  "data": [
    {
      "id": 0,
      "name": "string",
      "userId": 0
    }
  ]
}

Result«List«NoteType»»

属性

名称 类型 必选 约束 中文名 说明
status integer¦null false none none
message string¦null false none none
data [NoteType]¦null false none none

NoteAddForm

{
  "title": "string",
  "content": "string",
  "isPublic": "NO",
  "typeId": 1
}

NoteAddForm

属性

名称 类型 必选 约束 中文名 说明
title string¦null true none none
content string¦null true none none
isPublic string¦null true none none
typeId integer¦null false none none

枚举值

属性 值
isPublic NO
isPublic YES

NoteShareForm

{
  "noteId": 1,
  "expireTime": "new Date(System.currentTimeMillis() + 1000 * 3600 * 24 * 7)"
}

NoteShareForm

属性

名称 类型 必选 约束 中文名 说明
noteId integer¦null true none none
expireTime string¦null false none 默认为7天后过期

PageShareNoteVO

{
  "id": 0,
  "code": "string",
  "noteId": 0,
  "userId": 0,
  "expireTime": "string",
  "title": "string"
}

PageShareNoteVO

属性

名称 类型 必选 约束 中文名 说明
id integer¦null false none none
code string¦null false none none
noteId integer¦null false none none
userId integer¦null false none none
expireTime string¦null false none none
title string¦null false none none

PageVO«Image»

{
  "current": 0,
  "page": 0,
  "size": 0,
  "total": 0,
  "records": [
    {
      "id": 0,
      "userId": 0,
      "alias": "string",
      "name": "string",
      "uploadTime": "string",
      "url": "string",
      "size": 0
    }
  ]
}

PageVO«Image»

属性

名称 类型 必选 约束 中文名 说明
current integer¦null false none none
page integer¦null false none none
size integer¦null false none none
total integer¦null false none none
records [Image]¦null false none none

PageVO«PageShareNoteVO»

{
  "current": 0,
  "page": 0,
  "size": 0,
  "total": 0,
  "records": [
    {
      "id": 0,
      "code": "string",
      "noteId": 0,
      "userId": 0,
      "expireTime": "string",
      "title": "string"
    }
  ]
}

PageVO«PageShareNoteVO»

属性

名称 类型 必选 约束 中文名 说明
current integer¦null false none none
page integer¦null false none none
size integer¦null false none none
total integer¦null false none none
records [PageShareNoteVO]¦null false none none

Result«PageVO«Image»»

{
  "status": 0,
  "message": "string",
  "data": {
    "current": 0,
    "page": 0,
    "size": 0,
    "total": 0,
    "records": [
      {
        "id": 0,
        "userId": 0,
        "alias": "string",
        "name": "string",
        "uploadTime": "string",
        "url": "string",
        "size": 0
      }
    ]
  }
}

Result«PageVO«Image»»

属性

名称 类型 必选 约束 中文名 说明
status integer¦null false none none
message string¦null false none none
data PageVO«Image» false none none

Result«PageVO«PageShareNoteVO»»

{
  "status": 0,
  "message": "string",
  "data": {
    "current": 0,
    "page": 0,
    "size": 0,
    "total": 0,
    "records": [
      {
        "id": 0,
        "code": "string",
        "noteId": 0,
        "userId": 0,
        "expireTime": "string",
        "title": "string"
      }
    ]
  }
}

Result«PageVO«PageShareNoteVO»»

属性

名称 类型 必选 约束 中文名 说明
status integer¦null false none none
message string¦null false none none
data PageVO«PageShareNoteVO» false none none

UserLoginForm

{
  "account": "string",
  "password": "string"
}

UserLoginForm

属性

名称 类型 必选 约束 中文名 说明
account string¦null true none none
password string¦null true none none

UserRegisterForm

{
  "name": "string",
  "account": "string",
  "password": "string",
  "email": "string",
  "verificationCode": "string"
}

UserRegisterForm

属性

名称 类型 必选 约束 中文名 说明
name string¦null true none none
account string¦null true none none
password string¦null true none none
email string¦null true none none
verificationCode string¦null true none none

UserUpdateEmailForm

{
  "email": "string",
  "verificationCode": "string"
}

UserUpdateEmailForm

属性

名称 类型 必选 约束 中文名 说明
email string¦null true none none
verificationCode string¦null true none none

UserUpdateForm

{
  "name": "string",
  "homePageNoteId": 1
}

UserUpdateForm

属性

名称 类型 必选 约束 中文名 说明
name string¦null false none none
homePageNoteId integer¦null false none none

UserUpdatePasswordForm

{
  "password": "string"
}

UserUpdatePasswordForm

属性

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

Result«String»

{
  "status": 0,
  "message": "string",
  "data": "string"
}

属性

名称 类型 必选 约束 中文名 说明
status integer¦null false none none
message string¦null false none none
data string¦null false none none

Result«Object»

{
  "status": null,
  "message": null,
  "data": null
}

属性

名称 类型 必选 约束 中文名 说明
status null¦null false none none
message null¦null false none none
data null¦null false none none

Result«Integer»

{
  "status": 0,
  "message": "string",
  "data": 0
}

属性

名称 类型 必选 约束 中文名 说明
status integer¦null false none none
message string¦null false none none
data integer¦null false none none

ShareNoteVO

{
  "id": 0,
  "title": "string",
  "userId": 0,
  "releaseTime": "string",
  "isPublic": "NO",
  "updateTime": "string",
  "typeId": 0
}

属性

名称 类型 必选 约束 中文名 说明
id integer¦null false none none
title string¦null false none none
userId integer¦null false none none
releaseTime string¦null false none none
isPublic string¦null false none none
updateTime string¦null false none none
typeId integer¦null false none none

枚举值

属性 值
isPublic NO
isPublic YES

PageVO«ShareNoteVO»

{
  "current": 0,
  "page": 0,
  "size": 0,
  "total": 0,
  "records": [
    {
      "id": 0,
      "title": "string",
      "userId": 0,
      "releaseTime": "string",
      "isPublic": "NO",
      "updateTime": "string",
      "typeId": 0
    }
  ]
}

属性

名称 类型 必选 约束 中文名 说明
current integer¦null false none none
page integer¦null false none none
size integer¦null false none none
total integer¦null false none none
records [ShareNoteVO]¦null false none none

Result«PageVO«ShareNoteVO»»

{
  "status": 0,
  "message": "string",
  "data": {
    "current": 0,
    "page": 0,
    "size": 0,
    "total": 0,
    "records": [
      {
        "id": 0,
        "title": "string",
        "userId": 0,
        "releaseTime": "string",
        "isPublic": "NO",
        "updateTime": "string",
        "typeId": 0
      }
    ]
  }
}

属性

名称 类型 必选 约束 中文名 说明
status integer¦null false none none
message string¦null false none none
data PageVO«ShareNoteVO» false none none

NoteUpdateForm

{
  "id": 1,
  "title": "string",
  "content": "string",
  "isPublic": "NO",
  "typeId": 0
}

属性

名称 类型 必选 约束 中文名 说明
id integer¦null true none none
title string¦null false none none
content string¦null false none none
isPublic string¦null false none none
typeId integer¦null false none none

枚举值

属性 值
isPublic NO
isPublic YES

Result«?»

{
  "status": 0,
  "message": "string",
  "data": null
}

属性

名称 类型 必选 约束 中文名 说明
status integer¦null false none none
message string¦null false none none
data null¦null false none none

SearchNoteVO

{
  "id": 0,
  "title": "string",
  "userId": 0,
  "releaseTime": "string",
  "isPublic": "NO",
  "updateTime": "string",
  "typeId": 0
}

属性

名称 类型 必选 约束 中文名 说明
id integer¦null false none none
title string¦null false none none
userId integer¦null false none none
releaseTime string¦null false none none
isPublic string¦null false none none
updateTime string¦null false none none
typeId integer¦null false none none

枚举值

属性 值
isPublic NO
isPublic YES

PageVO«SearchNoteVO»

{
  "current": 0,
  "page": 0,
  "size": 0,
  "total": 0,
  "records": [
    {
      "id": 0,
      "title": "string",
      "userId": 0,
      "releaseTime": "string",
      "isPublic": "NO",
      "updateTime": "string",
      "typeId": 0
    }
  ]
}

属性

名称 类型 必选 约束 中文名 说明
current integer¦null false none none
page integer¦null false none none
size integer¦null false none none
total integer¦null false none none
records [SearchNoteVO]¦null false none none

Result«PageVO«SearchNoteVO»»

{
  "status": 0,
  "message": "string",
  "data": {
    "current": 0,
    "page": 0,
    "size": 0,
    "total": 0,
    "records": [
      {
        "id": 0,
        "title": "string",
        "userId": 0,
        "releaseTime": "string",
        "isPublic": "NO",
        "updateTime": "string",
        "typeId": 0
      }
    ]
  }
}

属性

名称 类型 必选 约束 中文名 说明
status integer¦null false none none
message string¦null false none none
data PageVO«SearchNoteVO» false none none

NoteUpdateTypeForm

{
  "noteIds": [
    0
  ],
  "typeId": 1
}

属性

名称 类型 必选 约束 中文名 说明
noteIds [integer]¦null true none none
typeId integer¦null true none none

Result«Set«String»»

{
  "status": 0,
  "message": "string",
  "data": [
    "string"
  ]
}

属性

名称 类型 必选 约束 中文名 说明
status integer¦null false none none
message string¦null false none none
data [string]¦null false none none

ShareNoteRecordCreateForm

{
  "noteId": 1,
  "expireTime": "new Timestamp(System.currentTimeMillis() + 1000 * 3600 * 24 * 7)"
}

属性

名称 类型 必选 约束 中文名 说明
noteId integer¦null true none none
expireTime string¦null false none 默认为7天后过期

ShareNoteRecordVO

{
  "id": 0,
  "code": "string",
  "noteId": 0,
  "userId": 0,
  "expireTime": "string",
  "title": "string"
}

属性

名称 类型 必选 约束 中文名 说明
id integer¦null false none none
code string¦null false none none
noteId integer¦null false none none
userId integer¦null false none none
expireTime string¦null false none none
title string¦null false none none

PageVO«ShareNoteRecordVO»

{
  "current": 0,
  "page": 0,
  "size": 0,
  "total": 0,
  "records": [
    {
      "id": 0,
      "code": "string",
      "noteId": 0,
      "userId": 0,
      "expireTime": "string",
      "title": "string"
    }
  ]
}

属性

名称 类型 必选 约束 中文名 说明
current integer¦null false none none
page integer¦null false none none
size integer¦null false none none
total integer¦null false none none
records [ShareNoteRecordVO]¦null false none none

Result«PageVO«ShareNoteRecordVO»»

{
  "status": 0,
  "message": "string",
  "data": {
    "current": 0,
    "page": 0,
    "size": 0,
    "total": 0,
    "records": [
      {
        "id": 0,
        "code": "string",
        "noteId": 0,
        "userId": 0,
        "expireTime": "string",
        "title": "string"
      }
    ]
  }
}

属性

名称 类型 必选 约束 中文名 说明
status integer¦null false none none
message string¦null false none none
data PageVO«ShareNoteRecordVO» false none none

ShareNoteRecordUpdateForm

{
  "id": 0,
  "expireTime": "new Timestamp(System.currentTimeMillis() + 1000 * 3600 * 24 * 7)"
}

属性

名称 类型 必选 约束 中文名 说明
id integer¦null false none none
expireTime string¦null false none none

SearchUserImageVO

{
  "id": 0,
  "userId": 0,
  "imageId": 0,
  "alias": "string",
  "lastDownloadTime": "string"
}

属性

名称 类型 必选 约束 中文名 说明
id integer¦null false none none
userId integer¦null false none none
imageId integer¦null false none none
alias string¦null false none none
lastDownloadTime string¦null false none none

PageVO«SearchUserImageVO»

{
  "current": 0,
  "page": 0,
  "size": 0,
  "total": 0,
  "records": [
    {
      "id": 0,
      "userId": 0,
      "imageId": 0,
      "alias": "string",
      "lastDownloadTime": "string"
    }
  ]
}

属性

名称 类型 必选 约束 中文名 说明
current integer¦null false none none
page integer¦null false none none
size integer¦null false none none
total integer¦null false none none
records [SearchUserImageVO]¦null false none none

Result«PageVO«SearchUserImageVO»»

{
  "status": 0,
  "message": "string",
  "data": {
    "current": 0,
    "page": 0,
    "size": 0,
    "total": 0,
    "records": [
      {
        "id": 0,
        "userId": 0,
        "imageId": 0,
        "alias": "string",
        "lastDownloadTime": "string"
      }
    ]
  }
}

属性

名称 类型 必选 约束 中文名 说明
status integer¦null false none none
message string¦null false none none
data PageVO«SearchUserImageVO» false none none

PageVO«Note»

{
  "current": 0,
  "page": 0,
  "size": 0,
  "total": 0,
  "records": [
    {
      "id": 0,
      "title": "string",
      "content": "string",
      "userId": 0,
      "releaseTime": "string",
      "updateTime": "string",
      "isPublic": "NO",
      "typeId": 0
    }
  ]
}

属性

名称 类型 必选 约束 中文名 说明
current integer¦null false none none
page integer¦null false none none
size integer¦null false none none
total integer¦null false none none
records [Note]¦null false none none

Result«PageVO«Note»»

{
  "status": 0,
  "message": "string",
  "data": {
    "current": 0,
    "page": 0,
    "size": 0,
    "total": 0,
    "records": [
      {
        "id": 0,
        "title": "string",
        "content": "string",
        "userId": 0,
        "releaseTime": "string",
        "updateTime": "string",
        "isPublic": "NO",
        "typeId": 0
      }
    ]
  }
}

属性

名称 类型 必选 约束 中文名 说明
status integer¦null false none none
message string¦null false none none
data PageVO«Note» false none none

NoteTypeAddForm

{
  "name": "string"
}

属性

名称 类型 必选 约束 中文名 说明
name string¦null true none none

NoteTypeUpdateForm

{
  "id": 1,
  "name": "string"
}

属性

名称 类型 必选 约束 中文名 说明
id integer¦null true none none
name string¦null true none none