Version | Update Time | Status | Author | Description |
---|---|---|---|---|
v2023-09-01 21:13:15 | 2023-09-01 21:13:15 | auto | @zhou | Created by smart-doc |
Type: POST
Author: zhou
Content-Type: application/json; charset=utf-8
Description: Login
Query-parameters:
Parameter | Type | Description | Required | Since |
---|---|---|---|---|
token | string | token for verification code | true | - |
code | string | verification code | true | - |
isAdmin | boolean | check whether the user is the administrator if {@code isAdmin} is true | false | - |
Body-parameters:
Parameter | Type | Description | Required | Since |
---|---|---|---|---|
userName | string | Username | true | - |
password | string | Password | true | - |
Response-fields:
Field | Type | Description | Since |
---|---|---|---|
code | int32 | Result Code | - |
msg | string | Message | - |
data | object | Data | - |
└─idempotencyKeyInfo | object | Idempotency key information | - |
└─idempotencyKeyHeaderName | string | The name of the HTTP header used to convey an idempotency key for the request | - |
└─idempotencyKey | string | Idempotency key | - |
└─saTokenInfo | object | Token information | - |
└─tokenName | string | No comments found. | - |
└─tokenValue | string | No comments found. | - |
└─isLogin | boolean | No comments found. | - |
└─loginId | object | No comments found. | - |
└─loginKey | string | No comments found. | - |
└─tokenTimeout | int64 | No comments found. | - |
└─sessionTimeout | int64 | No comments found. | - |
└─tokenSessionTimeout | int64 | No comments found. | - |
└─tokenActivityTimeout | int64 | No comments found. | - |
└─loginDevice | string | No comments found. | - |
Retrieve information about the idempotency key for the authenticated user.The key is used to ensure that duplicate requests are not processed multiple times.
URL: http://127.0.0.1/idempotency-key
Type: GET
Author: zhou
Content-Type: application/x-www-form-urlencoded;charset=utf-8
Description: Retrieve information about the idempotency key for the authenticated user. The key is used to ensure that duplicate requests are not processed multiple times.
Response-fields:
Field | Type | Description | Since |
---|---|---|---|
code | int32 | Result Code | - |
msg | string | Message | - |
data | object | Data | - |
└─idempotencyKeyHeaderName | string | The name of the HTTP header used to convey an idempotency key for the request | - |
└─idempotencyKey | string | Idempotency key | - |
Type: GET
Author: zhou
Content-Type: application/x-www-form-urlencoded;charset=utf-8
Description: Logout
Response-fields:
Field | Type | Description | Since |
---|---|---|---|
code | int32 | Result Code | - |
msg | string | Message | - |
data | object | Data | - |
URL: http://127.0.0.1/bookmark/
Type: GET
Author: zhou
Content-Type: application/x-www-form-urlencoded;charset=utf-8
Description: Bookmark a new web page
Query-parameters:
Parameter | Type | Description | Required | Since |
---|---|---|---|---|
url | string | URL of the web page to bookmark | true | - |
privacy | enum | PUBLIC -(public,true) PRIVATE -(private,false) |
true | - |
mode | enum | ADD_TO_DATABASE -(0,addToDatabase,add_to_database) ADD_TO_DATABASE_AND_ELASTICSEARCH -(1,addToDatabaseAndElasticsearch,add_to_database_and_elasticsearch) |
true | - |
Response-fields:
Field | Type | Description | Since |
---|---|---|---|
hasSavedToDatabase | boolean | True if the data was successfully saved to Database | - |
hasSavedToElasticsearch | boolean | True if Elasticsearch saved the data successfully. False if Elasticsearch can't save the data. Null if the data does not need to be saved to Elasticsearch. |
- |
URL: http://127.0.0.1/bookmark/
Type: POST
Author: zhou
Content-Type: application/json; charset=utf-8
Description: Add a website to the bookmarks
Body-parameters:
Parameter | Type | Description | Required | Since |
---|---|---|---|---|
title | string | Title | false | - |
url | string | Url | true | - |
img | string | Image | false | - |
desc | string | Description | false | - |
Response-fields:
Field | Type | Description | Since |
---|---|---|---|
code | int32 | Result Code | - |
msg | string | Message | - |
data | object | Data | - |
URL: http://127.0.0.1/bookmark/
Type: DELETE
Author: zhou
Content-Type: application/x-www-form-urlencoded;charset=utf-8
Description: Delete a bookmark
Query-parameters:
Parameter | Type | Description | Required | Since |
---|---|---|---|---|
id | int32 | ID of the bookmark | true | - |
Response-fields:
Field | Type | Description | Since |
---|---|---|---|
code | int32 | Result Code | - |
msg | string | Message | - |
data | object | Data | - |
URL: http://127.0.0.1/bookmark/privacy
Type: GET
Author: zhou
Content-Type: application/x-www-form-urlencoded;charset=utf-8
Description: Make the bookmark private if it's public and make it public if it's private.
Query-parameters:
Parameter | Type | Description | Required | Since |
---|---|---|---|---|
id | int32 | ID of the bookmark | true | - |
Response-fields:
Field | Type | Description | Since |
---|---|---|---|
code | int32 | Result Code | - |
msg | string | Message | - |
data | object | Data | - |
URL: http://127.0.0.1/bookmark/get
Type: GET
Author: zhou
Content-Type: application/x-www-form-urlencoded;charset=utf-8
Description: Get a bookmark
Query-parameters:
Parameter | Type | Description | Required | Since |
---|---|---|---|---|
id | int32 | ID of the bookmark | true | - |
Response-fields:
Field | Type | Description | Since |
---|---|---|---|
id | int32 | ID of the bookmark | - |
userName | string | name of the user who bookmarked the website | - |
title | string | title of the bookmarked website | - |
url | string | URL of the bookmarked website | - |
img | string | Image of the bookmarked website | - |
desc | string | Description of the bookmarked website | - |
createTime | object | Creation time | - |
└─seconds | int64 | No comments found. | - |
└─nanos | int32 | No comments found. | - |
isPublic | boolean | True if this is a public bookmark | - |
URL: http://127.0.0.1/bookmark/get/user
Type: GET
Author: zhou
Content-Type: application/x-www-form-urlencoded;charset=utf-8
Description: Get paginated bookmarks of the user currently logged in
Query-parameters:
Parameter | Type | Description | Required | Since |
---|---|---|---|---|
from | int32 | From | false | - |
size | int32 | Size | false | - |
Response-fields:
Field | Type | Description | Since |
---|---|---|---|
bookmarks | array | Paginated bookmarks | - |
└─id | int32 | ID of the bookmark | - |
└─userName | string | name of the user who bookmarked the website | - |
└─title | string | title of the bookmarked website | - |
└─url | string | URL of the bookmarked website | - |
└─img | string | Image of the bookmarked website | - |
└─desc | string | Description of the bookmarked website | - |
└─createTime | object | Creation time | - |
└─seconds | int64 | No comments found. | - |
└─nanos | int32 | No comments found. | - |
└─isPublic | boolean | True if this is a public bookmark | - |
totalPages | int32 | Total pages | - |
URL: http://127.0.0.1/bookmark/get/user/{username}
Type: GET
Author: zhou
Content-Type: application/x-www-form-urlencoded;charset=utf-8
Description: Get paginated public bookmarks of a user
Path-parameters:
Parameter | Type | Description | Required | Since |
---|---|---|---|---|
username | string | username of the user whose public bookmarks is being requested | true | - |
Query-parameters:
Parameter | Type | Description | Required | Since |
---|---|---|---|---|
from | int32 | From | false | - |
size | int32 | Size | false | - |
Response-fields:
Field | Type | Description | Since |
---|---|---|---|
bookmarks | array | Paginated bookmarks | - |
└─id | int32 | ID of the bookmark | - |
└─userName | string | name of the user who bookmarked the website | - |
└─title | string | title of the bookmarked website | - |
└─url | string | URL of the bookmarked website | - |
└─img | string | Image of the bookmarked website | - |
└─desc | string | Description of the bookmarked website | - |
└─createTime | object | Creation time | - |
└─seconds | int64 | No comments found. | - |
└─nanos | int32 | No comments found. | - |
└─isPublic | boolean | True if this is a public bookmark | - |
totalPages | int32 | Total pages | - |
URL: http://127.0.0.1/bookmark/visited-bookmarks
Type: GET
Author: zhou
Content-Type: application/x-www-form-urlencoded;charset=utf-8
Description: Get visited bookmarks
Query-parameters:
Parameter | Type | Description | Required | Since |
---|---|---|---|---|
from | int32 | From | false | - |
size | int32 | Size | false | - |
Response-fields:
Field | Type | Description | Since |
---|---|---|---|
userName | string | Username | - |
title | string | Title | - |
url | string | Url | - |
bookmarkId | int32 | ID of the bookmark | - |
isPublic | boolean | True if this is a public bookmark | - |
views | int32 | The number of views of this bookmark | - |
URL: http://127.0.0.1/notification/
Type: GET
Author: zhou
Content-Type: application/x-www-form-urlencoded;charset=utf-8
Description: Get notifications
Query-parameters:
Parameter | Type | Description | Required | Since |
---|---|---|---|---|
notificationType | enum | REPLY_NOTIFICATION -(NotificationConstant.REPLY_NOTIFICATION) SYSTEM_NOTIFICATION -(NotificationConstant.SYSTEM_NOTIFICATION) |
true | - |
loadCount | int32 | Number of notifications to be loaded | true | - |
Response-fields:
Field | Type | Description | Since |
---|---|---|---|
id | string | ID of the notification Null if the notification is deleted |
- |
notificationType | enum | Type of the notification. REPLY_NOTIFICATION -(NotificationConstant.REPLY_NOTIFICATION) SYSTEM_NOTIFICATION -(NotificationConstant.SYSTEM_NOTIFICATION) |
- |
message | string | The message of the notification Null if the bookmark, comment or reply has been deleted If the bookmark ID is not null and the message is null, |
- |
creationTime | object | Time of creation. | - |
└─seconds | int64 | No comments found. | - |
└─nanos | int32 | No comments found. | - |
sender | string | When the notification is a reply (or comment) notification, it represents the username of the sender. If the notification is a system notification, it represents the sender of the system notification. |
- |
recipientUserId | int32 | When the {@link NotificationType} is {@link NotificationType#REPLY_NOTIFICATION}, this represents the User ID of the recipient who will receive the reply notification. If {@link #getReplyToCommentId()} is null, the recipient is the owner of the bookmark. If {@link #getReplyToCommentId()} is not null, the recipient is the author of the comment being replied to.
|
- |
commentId | int32 | ID of the comment If the comment ID is null ,the comment doesn't exist |
- |
bookmarkId | int32 | ID of the bookmark If the bookmark ID is null, the bookmark doesn't exist. If the bookmark ID is not null and the message is null, |
- |
replyToCommentId | int32 | The ID of the comment being replied to Null if not replying to any comment, indicating it's a bookmark comment. |
- |
isRead | boolean | True if the notification is read | - |
accessStatus | enum | Access status BOOKMARK_NOT_EXIST UNAUTHORIZED COMMENT_NOT_EXIST ACCESSIBLE |
- |
URL: http://127.0.0.1/notification/read
Type: POST
Author: zhou
Content-Type: application/json; charset=utf-8
Description: Mark the notification as read
Body-parameters:
Parameter | Type | Description | Required | Since |
---|---|---|---|---|
id | string | ID of the notification Null if the notification is deleted |
false | - |
notificationType | enum | Type of the notification. REPLY_NOTIFICATION -(NotificationConstant.REPLY_NOTIFICATION) SYSTEM_NOTIFICATION -(NotificationConstant.SYSTEM_NOTIFICATION) |
false | - |
message | string | The message of the notification Null if the bookmark, comment or reply has been deleted If the bookmark ID is not null and the message is null, |
false | - |
creationTime | object | Time of creation. | false | - |
└─seconds | int64 | No comments found. | false | - |
└─nanos | int32 | No comments found. | false | - |
sender | string | When the notification is a reply (or comment) notification, it represents the username of the sender. If the notification is a system notification, it represents the sender of the system notification. |
false | - |
recipientUserId | int32 | When the {@link NotificationType} is {@link NotificationType#REPLY_NOTIFICATION}, this represents the User ID of the recipient who will receive the reply notification. If {@link #getReplyToCommentId()} is null, the recipient is the owner of the bookmark. If {@link #getReplyToCommentId()} is not null, the recipient is the author of the comment being replied to.
|
false | - |
commentId | int32 | ID of the comment If the comment ID is null ,the comment doesn't exist |
false | - |
bookmarkId | int32 | ID of the bookmark If the bookmark ID is null, the bookmark doesn't exist. If the bookmark ID is not null and the message is null, |
false | - |
replyToCommentId | int32 | The ID of the comment being replied to Null if not replying to any comment, indicating it's a bookmark comment. |
false | - |
URL: http://127.0.0.1/notification/unread
Type: POST
Author: zhou
Content-Type: application/json; charset=utf-8
Description: Mark the notification as unread
Body-parameters:
Parameter | Type | Description | Required | Since |
---|---|---|---|---|
id | string | ID of the notification Null if the notification is deleted |
false | - |
notificationType | enum | Type of the notification. REPLY_NOTIFICATION -(NotificationConstant.REPLY_NOTIFICATION) SYSTEM_NOTIFICATION -(NotificationConstant.SYSTEM_NOTIFICATION) |
false | - |
message | string | The message of the notification Null if the bookmark, comment or reply has been deleted If the bookmark ID is not null and the message is null, |
false | - |
creationTime | object | Time of creation. | false | - |
└─seconds | int64 | No comments found. | false | - |
└─nanos | int32 | No comments found. | false | - |
sender | string | When the notification is a reply (or comment) notification, it represents the username of the sender. If the notification is a system notification, it represents the sender of the system notification. |
false | - |
recipientUserId | int32 | When the {@link NotificationType} is {@link NotificationType#REPLY_NOTIFICATION}, this represents the User ID of the recipient who will receive the reply notification. If {@link #getReplyToCommentId()} is null, the recipient is the owner of the bookmark. If {@link #getReplyToCommentId()} is not null, the recipient is the author of the comment being replied to.
|
false | - |
commentId | int32 | ID of the comment If the comment ID is null ,the comment doesn't exist |
false | - |
bookmarkId | int32 | ID of the bookmark If the bookmark ID is null, the bookmark doesn't exist. If the bookmark ID is not null and the message is null, |
false | - |
replyToCommentId | int32 | The ID of the comment being replied to Null if not replying to any comment, indicating it's a bookmark comment. |
false | - |
URL: http://127.0.0.1/notification/count/reply
Type: GET
Author: zhou
Content-Type: application/x-www-form-urlencoded;charset=utf-8
Description: Calculate the count of current user's unread replies
Response-fields:
Field | Type | Description | Since |
---|---|---|---|
code | int32 | Result Code | - |
msg | string | Message | - |
data | object | Data | - |
URL: http://127.0.0.1/notification/count/system
Type: GET
Author: zhou
Content-Type: application/x-www-form-urlencoded;charset=utf-8
Description: Calculate the count of current user's unread replies
Response-fields:
Field | Type | Description | Since |
---|---|---|---|
code | int32 | Result Code | - |
msg | string | Message | - |
data | object | Data | - |
URL: http://127.0.0.1/notification/count/all
Type: GET
Author: zhou
Content-Type: application/x-www-form-urlencoded;charset=utf-8
Description: Count the total number of notifications
Query-parameters:
Parameter | Type | Description | Required | Since |
---|---|---|---|---|
notificationType | enum | REPLY_NOTIFICATION -(NotificationConstant.REPLY_NOTIFICATION) SYSTEM_NOTIFICATION -(NotificationConstant.SYSTEM_NOTIFICATION) |
true | - |
URL: http://127.0.0.1/notification/system/send
Type: GET
Author: zhou
Content-Type: application/x-www-form-urlencoded;charset=utf-8
Description: Send system notification
Query-parameters:
Parameter | Type | Description | Required | Since |
---|---|---|---|---|
message | string | notification message | true | - |
URL: http://127.0.0.1/notification/system
Type: GET
Author: zhou
Content-Type: application/x-www-form-urlencoded;charset=utf-8
Description: Check if the user has unread system notifications
URL: http://127.0.0.1/notification/role-changed
Type: GET
Author: zhou
Content-Type: application/x-www-form-urlencoded;charset=utf-8
Description: Get current user's role change notification
Response-fields:
Field | Type | Description | Since |
---|---|---|---|
code | int32 | Result Code | - |
msg | string | Message | - |
data | object | Data | - |
URL: http://127.0.0.1/notification/role-changed
Type: DELETE
Author: zhou
Content-Type: application/x-www-form-urlencoded;charset=utf-8
Description: Delete role change notification for current user
URL: http://127.0.0.1/notification/mute
Type: GET
Author: zhou
Content-Type: application/x-www-form-urlencoded;charset=utf-8
Description: Check if the user currently logged in has turned off notifications
Response-fields:
Field | Type | Description | Since |
---|---|---|---|
code | int32 | Result Code | - |
msg | string | Message | - |
data | object | Data | - |
Turn on notifications if the current user turned off notifications andturn off notifications if the current user turned on notifications
URL: http://127.0.0.1/notification/mute/switch
Type: GET
Author: zhou
Content-Type: application/x-www-form-urlencoded;charset=utf-8
Description: Turn on notifications if the current user turned off notifications and turn off notifications if the current user turned on notifications
URL: http://127.0.0.1/tag/apply
Type: GET
Author: zhou
Content-Type: application/x-www-form-urlencoded;charset=utf-8
Description: Apply a tag
Query-parameters:
Parameter | Type | Description | Required | Since |
---|---|---|---|---|
bookmarkId | int32 | ID of the bookmark that the user currently logged in wants to apply the tag to | true | - |
tag | string | the tag to apply | true | - |
Response-fields:
Field | Type | Description | Since |
---|---|---|---|
code | int32 | Result Code | - |
msg | string | Message | - |
data | object | Data | - |
Get tags by the ID of the bookmark<p>Get all tags if the parameter {@code bookmarkId} is missing.</p>
Type: GET
Author: zhou
Content-Type: application/x-www-form-urlencoded;charset=utf-8
Description: Get tags by the ID of the bookmark
Get all tags if the parameter {@code bookmarkId} is missing.
Query-parameters:
Parameter | Type | Description | Required | Since |
---|---|---|---|---|
bookmarkId | int32 | ID of the bookmark | false | - |
from | int32 | From | false | - |
size | int32 | Size | false | - |
Response-fields:
Field | Type | Description | Since |
---|---|---|---|
code | int32 | Result Code | - |
msg | string | Message | - |
data | array | Data | - |
Type: GET
Author: zhou
Content-Type: application/x-www-form-urlencoded;charset=utf-8
Description: Get a tag of a bookmark, or return empty string if the bookmark has no tags
Query-parameters:
Parameter | Type | Description | Required | Since |
---|---|---|---|---|
bookmarkId | int32 | ID of the bookmark | true | - |
Response-fields:
Field | Type | Description | Since |
---|---|---|---|
code | int32 | Result Code | - |
msg | string | Message | - |
data | object | Data | - |
Search bookmarks by a certain tag.<p>If some bookmarks is not public and the user currently logged inis not the owner, then those bookmarks will not be shown.</p>
URL: http://127.0.0.1/tag/search
Type: GET
Author: zhou
Content-Type: application/x-www-form-urlencoded;charset=utf-8
Description: Search bookmarks by a certain tag.
If some bookmarks is not public and the user currently logged in is not the owner, then those bookmarks will not be shown.
Query-parameters:
Parameter | Type | Description | Required | Since |
---|---|---|---|---|
tagName | string | name of the tag to search for | true | - |
from | int32 | From | false | - |
size | int32 | Size | false | - |
Response-fields:
Field | Type | Description | Since |
---|---|---|---|
id | int32 | ID of the bookmark | - |
userName | string | name of the user who bookmarked the website | - |
title | string | title of the bookmarked website | - |
url | string | URL of the bookmarked website | - |
img | string | Image of the bookmarked website | - |
desc | string | Description of the bookmarked website | - |
createTime | object | Creation time | - |
└─seconds | int64 | No comments found. | - |
└─nanos | int32 | No comments found. | - |
isPublic | boolean | True if this is a public bookmark | - |
Search bookmarks by a certain tag and get total pages.<p>If some bookmarks is not public and the user currently logged inis not the owner, then those bookmarks will not be shown.</p>
URL: http://127.0.0.1/tag/search/{tagName}
Type: GET
Author: zhou
Content-Type: application/x-www-form-urlencoded;charset=utf-8
Description: Search bookmarks by a certain tag and get total pages.
If some bookmarks is not public and the user currently logged in is not the owner, then those bookmarks will not be shown.
Path-parameters:
Parameter | Type | Description | Required | Since |
---|---|---|---|---|
tagName | string | name of the tag to search for | true | - |
Query-parameters:
Parameter | Type | Description | Required | Since |
---|---|---|---|---|
from | int32 | From | false | - |
size | int32 | Size | false | - |
Response-fields:
Field | Type | Description | Since |
---|---|---|---|
bookmarks | array | Paginated bookmarks associated with the chosen tag | - |
└─id | int32 | ID of the bookmark | - |
└─userName | string | name of the user who bookmarked the website | - |
└─title | string | title of the bookmarked website | - |
└─url | string | URL of the bookmarked website | - |
└─img | string | Image of the bookmarked website | - |
└─desc | string | Description of the bookmarked website | - |
└─createTime | object | Creation time | - |
└─seconds | int64 | No comments found. | - |
└─nanos | int32 | No comments found. | - |
└─isPublic | boolean | True if this is a public bookmark | - |
totalPages | int32 | Total pages | - |
URL: http://127.0.0.1/tag/popular
Type: GET
Author: zhou
Content-Type: application/x-www-form-urlencoded;charset=utf-8
Description: Get popular tags.
Query-parameters:
Parameter | Type | Description | Required | Since |
---|---|---|---|---|
from | int32 | From | false | - |
size | int32 | Size | false | - |
Response-fields:
Field | Type | Description | Since |
---|---|---|---|
code | int32 | Result Code | - |
msg | string | Message | - |
data | array | Data | - |
└─tag | string | Tag | - |
└─number | int32 | Count the number of bookmarks of this tag | - |
Type: DELETE
Author: zhou
Content-Type: application/x-www-form-urlencoded;charset=utf-8
Description: Delete a tag
Query-parameters:
Parameter | Type | Description | Required | Since |
---|---|---|---|---|
bookmarkId | int32 | ID of the bookmarked website data that the tag applied to | true | - |
tagName | string | name of the tag to be deleted | true | - |
Response-fields:
Field | Type | Description | Since |
---|---|---|---|
code | int32 | Result Code | - |
msg | string | Message | - |
data | object | Data | - |
URL: http://127.0.0.1/comment/
Type: GET
Author: zhou
Content-Type: application/x-www-form-urlencoded;charset=utf-8
Description: Get a comment
Query-parameters:
Parameter | Type | Description | Required | Since |
---|---|---|---|---|
id | int32 | ID of the comment. |
<p>Return {@link ResultCode#FAILED} if {@code commentId} is null.</p>|false|-
bookmarkId|int32|ID of the bookmark|true|-
Response-fields:
Field | Type | Description | Since |
---|---|---|---|
code | int32 | Result Code | - |
msg | string | Message | - |
data | object | Data | - |
└─id | int32 | ID of the comment | - |
└─comment | string | Content | - |
└─bookmarkId | int32 | ID of the bookmark | - |
└─username | string | Username | - |
└─creationTime | object | Creation time | - |
└─seconds | int64 | No comments found. | - |
└─nanos | int32 | No comments found. | - |
└─replyToCommentId | int32 | ID of the comment to reply
|
- |
└─history | array | Edit history of the comment If the comment has not been edited, this will be an empty list |
- |
└─comment | string | Comment | - |
└─creationTime | object | Creation time | - |
└─seconds | int64 | No comments found. | - |
└─nanos | int32 | No comments found. | - |
URL: http://127.0.0.1/comment/bookmark
Type: GET
Author: zhou
Content-Type: application/x-www-form-urlencoded;charset=utf-8
Description: Get comment data of a bookmark
Query-parameters:
Parameter | Type | Description | Required | Since |
---|---|---|---|---|
id | int32 | ID of the bookmark | true | - |
replyToCommentId | int32 | ID of the comment to reply |
<p>
Null if this is not a reply
</p>|false|-
load|int32| Amount of data to load|true|-
order|enum|ASC -(asc,false)
DESC -(desc,true)
|true|-
Response-fields:
Field | Type | Description | Since |
---|---|---|---|
code | int32 | Result Code | - |
msg | string | Message | - |
data | array | Data | - |
└─id | int32 | ID of the comment | - |
└─comment | string | Content | - |
└─username | string | Username | - |
└─creationTime | object | Creation time | - |
└─seconds | int64 | No comments found. | - |
└─nanos | int32 | No comments found. | - |
└─replyToCommentId | int32 | ID of the comment to reply
|
- |
└─repliesCount | int32 | Count of the replies from this comment | - |
└─history | array | Edit history of the comment If the comment has not been edited, this will be an empty list |
- |
└─comment | string | Comment | - |
└─creationTime | object | Creation time | - |
└─seconds | int64 | No comments found. | - |
└─nanos | int32 | No comments found. | - |
URL: http://127.0.0.1/comment/bookmark/{id}
Type: GET
Author: zhou
Content-Type: application/x-www-form-urlencoded;charset=utf-8
Description: Get the number of comments (exclude replies) of a bookmark
Path-parameters:
Parameter | Type | Description | Required | Since |
---|---|---|---|---|
id | int32 | ID of the bookmark | true | - |
Response-fields:
Field | Type | Description | Since |
---|---|---|---|
code | int32 | Result Code | - |
msg | string | Message | - |
data | object | Data | - |
URL: http://127.0.0.1/comment/create
Type: GET
Author: zhou
Content-Type: application/x-www-form-urlencoded;charset=utf-8
Description: Create a comment and send a notification to the user who is about to receive it
Query-parameters:
Parameter | Type | Description | Required | Since |
---|---|---|---|---|
comment | string | Comment | true | - |
bookmarkId | int32 | ID of the bookmark | true | - |
replyToCommentId | int32 | ID of the comment to reply |
<p>
Null if this is not a reply
</p>|false|-
Response-fields:
Field | Type | Description | Since |
---|---|---|---|
code | int32 | Result Code | - |
msg | string | Message | - |
data | object | Data | - |
URL: http://127.0.0.1/comment/
Type: POST
Author: zhou
Content-Type: application/json; charset=utf-8
Description: Edit a comment
Body-parameters:
Parameter | Type | Description | Required | Since |
---|---|---|---|---|
id | int32 | ID of the comment | true | - |
comment | string | New comment | true | - |
bookmarkId | int32 | ID of the bookmark | true | - |
Response-fields:
Field | Type | Description | Since |
---|---|---|---|
code | int32 | Result Code | - |
msg | string | Message | - |
data | object | Data | - |
URL: http://127.0.0.1/comment/
Type: DELETE
Author: zhou
Content-Type: application/x-www-form-urlencoded;charset=utf-8
Description: Delete a comment
Query-parameters:
Parameter | Type | Description | Required | Since |
---|---|---|---|---|
id | int32 | ID of the comment | true | - |
Response-fields:
Field | Type | Description | Since |
---|---|---|---|
code | int32 | Result Code | - |
msg | string | Message | - |
data | object | Data | - |
URL: http://127.0.0.1/system/logs
Type: GET
Author: zhou
Content-Type: application/x-www-form-urlencoded;charset=utf-8
Description: Get system logs from cache and database
Query-parameters:
Parameter | Type | Description | Required | Since |
---|---|---|---|---|
from | int32 | From | false | - |
size | int32 | Size | false | - |
Response-fields:
Field | Type | Description | Since |
---|---|---|---|
code | int32 | Result Code | - |
msg | string | Message | - |
data | array | Data | - |
└─title | string | Title | - |
└─optType | string | CREATE, READ, UPDATE, DELETE, OTHERS |
- |
└─method | string | Method | - |
└─msg | string | Message | - |
└─status | string | Normal or Error | - |
└─optTime | object | Creation time | - |
└─seconds | int64 | No comments found. | - |
└─nanos | int32 | No comments found. | - |
URL: http://127.0.0.1/system/logs/no-cache
Type: GET
Author: zhou
Content-Type: application/x-www-form-urlencoded;charset=utf-8
Description: Get system logs from database directly
Query-parameters:
Parameter | Type | Description | Required | Since |
---|---|---|---|---|
from | int32 | From | false | - |
size | int32 | Size | false | - |
Response-fields:
Field | Type | Description | Since |
---|---|---|---|
code | int32 | Result Code | - |
msg | string | Message | - |
data | array | Data | - |
└─title | string | Title | - |
└─optType | string | CREATE, READ, UPDATE, DELETE, OTHERS |
- |
└─method | string | Method | - |
└─msg | string | Message | - |
└─status | string | Normal or Error | - |
└─optTime | object | Creation time | - |
└─seconds | int64 | No comments found. | - |
└─nanos | int32 | No comments found. | - |
Type: GET
Author: zhou
Content-Type: application/x-www-form-urlencoded;charset=utf-8
Description: Increase the number of views of a bookmark
Query-parameters:
Parameter | Type | Description | Required | Since |
---|---|---|---|---|
bookmarkId | int32 | ID of the bookmark | true | - |
URL: http://127.0.0.1/view/count
Type: GET
Author: zhou
Content-Type: application/x-www-form-urlencoded;charset=utf-8
Description: Count the number of views of a bookmark
Query-parameters:
Parameter | Type | Description | Required | Since |
---|---|---|---|---|
bookmarkId | int32 | ID of the bookmark | true | - |
Response-fields:
Field | Type | Description | Since |
---|---|---|---|
code | int32 | Result Code | - |
msg | string | Message | - |
data | object | Data | - |
Save the numbers of views from Redis to the database,or add the view data from database to Redis if the Redis has no view data
URL: http://127.0.0.1/view/update
Type: GET
Author: zhou
Content-Type: application/x-www-form-urlencoded;charset=utf-8
Description: Save the numbers of views from Redis to the database, or add the view data from database to Redis if the Redis has no view data
Response-fields:
Field | Type | Description | Since |
---|---|---|---|
code | int32 | Result Code | - |
msg | string | Message | - |
data | array | Data | - |
Type: GET
Author: zhou
Content-Type: application/x-www-form-urlencoded;charset=utf-8
Description: Search
Query-parameters:
Parameter | Type | Description | Required | Since |
---|---|---|---|---|
mode | enum | WEB -(SearchConstant.INDEX_WEB) TAG -(SearchConstant.INDEX_TAG) USER -(SearchConstant.INDEX_USER) BOOKMARK_MYSQL -(SearchConstant.SEARCH_BOOKMARK_IN_MYSQL) TAG_MYSQL -(SearchConstant.SEARCH_TAG_IN_MYSQL) USER_MYSQL -(SearchConstant.SEARCH_USER_IN_MYSQL) |
true | - |
keyword | string | keyword | true | - |
from | int32 | From | false | - |
size | int32 | Size | false | - |
rangeFrom | int32 | lower range value for range query if the search mode is {@link SearchMode#TAG}. Null indicates | ||
unbounded. | false | - | ||
rangeTo | int32 | upper range value for range query if the search mode is {@link SearchMode#TAG}. Null indicates | ||
unbounded. | false | - |
Response-fields:
Field | Type | Description | Since |
---|---|---|---|
code | int32 | Result Code | - |
msg | string | Message | - |
data | object | Data | - |
└─totalCount | int64 | Total number of results | - |
└─totalPage | int32 | Total pages of results | - |
└─paginatedResults | array | Paginated search results | - |
Type: DELETE
Author: zhou
Content-Type: application/x-www-form-urlencoded;charset=utf-8
Description: Check and delete data in Elasticsearch
Query-parameters:
Parameter | Type | Description | Required | Since |
---|---|---|---|---|
mode | enum | WEB -(SearchConstant.INDEX_WEB) TAG -(SearchConstant.INDEX_TAG) USER -(SearchConstant.INDEX_USER) BOOKMARK_MYSQL -(SearchConstant.SEARCH_BOOKMARK_IN_MYSQL) TAG_MYSQL -(SearchConstant.SEARCH_TAG_IN_MYSQL) USER_MYSQL -(SearchConstant.SEARCH_USER_IN_MYSQL) |
true | - |
Response-fields:
Field | Type | Description | Since |
---|---|---|---|
code | int32 | Result Code | - |
msg | string | Message | - |
data | object | Data | - |
URL: http://127.0.0.1/search/load
Type: GET
Author: zhou
Content-Type: application/x-www-form-urlencoded;charset=utf-8
Description: Get trending searches, existent of bookmark data for search and the update information.
Response-fields:
Field | Type | Description | Since |
---|---|---|---|
trendingList | array | Trending searches | - |
dataStatus | boolean | True if search data is available | - |
hasNewUpdate | boolean | True if the website data in database is different from the data in Elasticsearch | - |
URL: http://127.0.0.1/search/status
Type: GET
Author: zhou
Content-Type: application/x-www-form-urlencoded;charset=utf-8
Description: Check the existent and changes of data
Query-parameters:
Parameter | Type | Description | Required | Since |
---|---|---|---|---|
mode | enum | WEB -(SearchConstant.INDEX_WEB) TAG -(SearchConstant.INDEX_TAG) USER -(SearchConstant.INDEX_USER) BOOKMARK_MYSQL -(SearchConstant.SEARCH_BOOKMARK_IN_MYSQL) TAG_MYSQL -(SearchConstant.SEARCH_TAG_IN_MYSQL) USER_MYSQL -(SearchConstant.SEARCH_USER_IN_MYSQL) |
true | - |
Response-fields:
Field | Type | Description | Since |
---|---|---|---|
exists | boolean | Existence of data | - |
hasChanges | boolean | Changes of data | - |
URL: http://127.0.0.1/search/build
Type: GET
Author: zhou
Content-Type: application/x-www-form-urlencoded;charset=utf-8
Description: Data generation for Elasticsearch based on database
Query-parameters:
Parameter | Type | Description | Required | Since |
---|---|---|---|---|
mode | enum | WEB -(SearchConstant.INDEX_WEB) TAG -(SearchConstant.INDEX_TAG) USER -(SearchConstant.INDEX_USER) BOOKMARK_MYSQL -(SearchConstant.SEARCH_BOOKMARK_IN_MYSQL) TAG_MYSQL -(SearchConstant.SEARCH_TAG_IN_MYSQL) USER_MYSQL -(SearchConstant.SEARCH_USER_IN_MYSQL) |
true | - |
Response-fields:
Field | Type | Description | Since |
---|---|---|---|
code | int32 | Result Code | - |
msg | string | Message | - |
data | object | Data | - |
URL: http://127.0.0.1/search/trending/{word}
Type: DELETE
Author: zhou
Content-Type: application/x-www-form-urlencoded;charset=utf-8
Description: Delete a specific trending keyword (Guest does not have the permission)
Path-parameters:
Parameter | Type | Description | Required | Since |
---|---|---|---|---|
word | string | keyword to delete | true | - |
Response-fields:
Field | Type | Description | Since |
---|---|---|---|
code | int32 | Result Code | - |
msg | string | Message | - |
data | object | Data | - |
URL: http://127.0.0.1/search/trending
Type: DELETE
Author: zhou
Content-Type: application/x-www-form-urlencoded;charset=utf-8
Description: Delete all trending keywords (Guest does not have the permission)
Response-fields:
Field | Type | Description | Since |
---|---|---|---|
code | int32 | Result Code | - |
msg | string | Message | - |
data | object | Data | - |
Export user's bookmarks to an HTML file.<p>Export bookmarks belonging to the user that is currently logged inif the username is missing.</p>
Type: GET
Author: zhou
Content-Type: application/x-www-form-urlencoded;charset=utf-8
Description: Export user's bookmarks to an HTML file.
Export bookmarks belonging to the user that is currently logged in if the username is missing.
Query-parameters:
Parameter | Type | Description | Required | Since |
---|---|---|---|---|
username | string | username of the user whose data is being exported. | false | - |
Type: POST
Author: zhou
Content-Type: application/json; charset=utf-8
Description: Import an HTML file that contains bookmarks
Query-parameters:
Parameter | Type | Description | Required | Since |
---|---|---|---|---|
htmlFile | file | a file that contains bookmarks in HTML format | true | - |
Response-fields:
Field | Type | Description | Since |
---|---|---|---|
code | int32 | Result Code | - |
msg | string | Message | - |
data | object | Data | - |
URL: http://127.0.0.1/verification/code
Type: GET
Author: zhou
Content-Type: application/x-www-form-urlencoded;charset=utf-8
Description: Get the verification code
Query-parameters:
Parameter | Type | Description | Required | Since |
---|---|---|---|---|
token | string | token for verification code | true | - |
URL: http://127.0.0.1/verification/invitation-code
Type: GET
Author: zhou
Content-Type: application/x-www-form-urlencoded;charset=utf-8
Description: Send invitation code
Query-parameters:
Parameter | Type | Description | Required | Since |
---|---|---|---|---|
token | string | token for invitation code | true | - |
string | true | - |
Type: GET
Author: zhou
Content-Type: application/x-www-form-urlencoded;charset=utf-8
Description: Get {@link HomePageVO} Data
Query-parameters:
Parameter | Type | Description | Required | Since |
---|---|---|---|---|
timeline | enum | LATEST_TIMELINE -(HomeTimelineConstant.LATEST_TIMELINE) USER_SPECIFIC_TIMELINE -(HomeTimelineConstant.USER_SPECIFIC_TIMELINE) TIMELINE_WITH_BLACKLIST -(HomeTimelineConstant.TIMELINE_WITH_BLACKLIST) |
true | - |
requestedUsername | string | username of the user whose data is being requested |
<p>{@code requestedUsername} is not required</p>|false|-
from|int32|From|false|- size|int32|Size|false|-
Response-fields:
Field | Type | Description | Since |
---|---|---|---|
currentUser | string | Username of the user that is currently logged in | - |
bookmarksAndTotalPages | object | Paginated bookmarks and total pages | - |
└─bookmarks | array | Paginated bookmarks | - |
└─id | int32 | ID of the bookmark | - |
└─userName | string | name of the user who bookmarked the website | - |
└─title | string | title of the bookmarked website | - |
└─url | string | URL of the bookmarked website | - |
└─img | string | Image of the bookmarked website | - |
└─desc | string | Description of the bookmarked website | - |
└─createTime | object | Creation time | - |
└─seconds | int64 | No comments found. | - |
└─nanos | int32 | No comments found. | - |
└─isPublic | boolean | True if this is a public bookmark | - |
└─totalPages | int32 | Total pages | - |
requestedUsername | string | Username of the user whose data is being requested | - |
Filter public bookmarked sites<p>{@code fromTimestamp} and {@code toTimestamp} is used to query a specific range of time.</p><li>It will not query a range of time if both of them are null.</li><li>It will set the null value to the current time if one of them is null</li><li>It will swap the two values if necessary.</li>
URL: http://127.0.0.1/home/filter
Type: POST
Author: zhou
Content-Type: application/json; charset=utf-8
Description: Filter public bookmarked sites
{@code fromTimestamp} and {@code toTimestamp} is used to query a specific range of time.
Query-parameters:
Parameter | Type | Description | Required | Since |
---|---|---|---|---|
load | int32 | amount of data to load | true | - |
fromTimestamp | string | filter by time | false | - |
toTimestamp | string | filter by time | false | - |
orderField | enum | USER_NAME -(userName,user_name) CREATION_TIME -(creationTime,creation_time) |
true | - |
order | enum | ASC -(asc,false) DESC -(desc,true) |
true | - |
Body-parameters:
Parameter | Type | Description | Required | Since |
---|---|---|---|---|
usernames | array | Usernames | false | - |
Response-fields:
Field | Type | Description | Since |
---|---|---|---|
id | int32 | ID of the bookmark | - |
userName | string | name of the user who bookmarked the website | - |
title | string | title of the bookmarked website | - |
url | string | URL of the bookmarked website | - |
img | string | Image of the bookmarked website | - |
desc | string | Description of the bookmarked website | - |
createTime | object | Creation time | - |
└─seconds | int64 | No comments found. | - |
└─nanos | int32 | No comments found. | - |
isPublic | boolean | True if this is a public bookmark | - |
URL: http://127.0.0.1/home/popular
Type: GET
Author: zhou
Content-Type: application/x-www-form-urlencoded;charset=utf-8
Description: Get popular bookmarks and total pages
Query-parameters:
Parameter | Type | Description | Required | Since |
---|---|---|---|---|
from | int32 | From | false | - |
size | int32 | Size | false | - |
Response-fields:
Field | Type | Description | Since |
---|---|---|---|
bookmarks | array | Popular bookmarks | - |
└─title | string | Title | - |
└─url | string | Url | - |
└─img | string | Image | - |
└─desc | string | Description | - |
└─count | int32 | The number of users who bookmarked the website | - |
totalPages | int32 | Total pages | - |
Type: POST
Author: zhou
Content-Type: application/json; charset=utf-8
Description: Create a user and return the username
Query-parameters:
Parameter | Type | Description | Required | Since |
---|---|---|---|---|
code | string | verification code | true | - |
token | string | token for verification Code | true | - |
role | enum | USER -(user) GUEST -(guest) ADMIN -(admin) |
true | - |
invitationCode | string | invitation code (the value will be ignored if the user role is not {@link |
UserRole#ADMIN})|false|-
invitationToken|string| token for invitation code (the value will be ignored if the user role is not {@link UserRole#ADMIN})|false|-
Body-parameters:
Parameter | Type | Description | Required | Since |
---|---|---|---|---|
userName | string | Username | true | - |
password | string | Password | true | - |
Response-fields:
Field | Type | Description | Since |
---|---|---|---|
code | int32 | Result Code | - |
msg | string | Message | - |
data | object | Data | - |
Type: DELETE
Author: zhou
Content-Type: application/x-www-form-urlencoded;charset=utf-8
Description: Delete a user and all of the data associated with that user
Query-parameters:
Parameter | Type | Description | Required | Since |
---|---|---|---|---|
userName | string | The username of the user to be deleted | true | - |
password | string | The password that the user entered | true | - |
Response-fields:
Field | Type | Description | Since |
---|---|---|---|
code | int32 | Result Code | - |
msg | string | Message | - |
data | object | Data | - |
Type: GET
Author: zhou
Content-Type: application/x-www-form-urlencoded;charset=utf-8
Description: Get personal information of current user
Response-fields:
Field | Type | Description | Since |
---|---|---|---|
user | object | User information | - |
└─id | int32 | ID | - |
└─userName | string | Username | - |
└─createTime | object | Creation Time | - |
└─seconds | int64 | No comments found. | - |
└─nanos | int32 | No comments found. | - |
└─role | string | User Role | - |
ip | string | IP Address | - |
URL: http://127.0.0.1/user/all
Type: GET
Author: zhou
Content-Type: application/x-www-form-urlencoded;charset=utf-8
Description: Get users
Query-parameters:
Parameter | Type | Description | Required | Since |
---|---|---|---|---|
from | int32 | From | false | - |
size | int32 | Size | false | - |
Response-fields:
Field | Type | Description | Since |
---|---|---|---|
id | int32 | ID | - |
userName | string | Username | - |
createTime | object | Creation Time | - |
└─seconds | int64 | No comments found. | - |
└─nanos | int32 | No comments found. | - |
role | string | User Role | - |
Get usernames of the users and the total numbers of their public bookmarkssorted by the total number<p>Get all usernames in database if {@code usernames} is null or empty.</p>
URL: http://127.0.0.1/user/usernames-and-bookmarks
Type: POST
Author: zhou
Content-Type: application/x-www-form-urlencoded;charset=utf-8
Description: Get usernames of the users and the total numbers of their public bookmarks sorted by the total number
Get all usernames in database if {@code usernames} is null or empty.
Query-parameters:
Parameter | Type | Description | Required | Since |
---|---|---|---|---|
usernames | array | Usernames | false | - |
Response-fields:
Field | Type | Description | Since |
---|---|---|---|
userName | string | Username | - |
bookmarkNumber | int32 | Total number of the user's public bookmarks | - |
URL: http://127.0.0.1/user/bookmarks-ranking-by-role
Type: GET
Author: zhou
Content-Type: application/x-www-form-urlencoded;charset=utf-8
Description: Retrieve the ranking of the number of bookmarks for each role
Response-fields:
Field | Type | Description | Since |
---|---|---|---|
ranking | int32 | Ranking | - |
role | string | Role of the user | - |
bookmarkNumber | int32 | Number of bookmarks | - |
userName | string | Username of the user | - |
URL: http://127.0.0.1/user/change-password
Type: POST
Author: zhou
Content-Type: application/json; charset=utf-8
Description: Change Password
Body-parameters:
Parameter | Type | Description | Required | Since |
---|---|---|---|---|
userName | string | Username | true | - |
oldPassword | string | Old password | true | - |
newPassword | string | New password | true | - |
Response-fields:
Field | Type | Description | Since |
---|---|---|---|
code | int32 | Result Code | - |
msg | string | Message | - |
data | object | Data | - |
URL: http://127.0.0.1/user/role
Type: GET
Author: zhou
Content-Type: application/x-www-form-urlencoded;charset=utf-8
Description: Change user role
Query-parameters:
Parameter | Type | Description | Required | Since |
---|---|---|---|---|
id | int32 | ID of the user | true | - |
newRole | string | the new role of the user | true | - |
Response-fields:
Field | Type | Description | Since |
---|---|---|---|
code | int32 | Result Code | - |
msg | string | Message | - |
data | object | Data | - |
URL: http://127.0.0.1/user/admin
Type: GET
Author: zhou
Content-Type: application/x-www-form-urlencoded;charset=utf-8
Description: Check if the user currently logged in is admin
Response-fields:
Field | Type | Description | Since |
---|---|---|---|
code | int32 | Result Code | - |
msg | string | Message | - |
data | object | Data | - |