UCL_IBM_cARd

v1.0.0

User

POST User List

POST /user/list

Show the requested user details

Parameters

Name	Place	Type	Required	Description
pageNum	query	string	Yes	Number of page
pageSize	query	string	Yes	Items per page

Sample Response

Success

{
  "code": 1,
  "data": {
    "id": 36,
    "name": "test",
    "username": "test",
    "password": "laborum nisi ex minim",
    "avatar": "http://dummyimage.com/100x100",
    "desc": "amet velit",
    "age": 25,
    "roleId": 31,
    "updatedAt": "1988-10-14 18:20:40",
    "createdAt": "1982-02-24 02:34:59"
  }
}

Reponse

Status Code	Status Code Meaning	Description	Data Scheme
200	OK	Success	Inline
500	Internal Server Error	Failed	Inline

Response Structure

Status Code 200

Name	Type	Required	Constraint	Description
» code	integer	true	none	none
» data	object	true	none	none
»» id	integer	true	none	none
»» name	string	true	none	none
»» username	string	true	none	none
»» password	string	true	none	none
»» avatar	string	true	none	none
»» desc	string	true	none	none
»» age	integer	true	none	none
»» roleId	integer	true	none	none
»» updatedAt	string	true	none	none
»» createdAt	string	true	none	none

POST User Add

POST /user/add

Add an new User

Parameters

Name	Place	Type	Required	Description
name	query	string	Yes	none
username	query	string	Yes	none
password	query	string	Yes	none
avatar	query	string	No	URL of img
desc	query	string	No	description
age	query	string	No	none
roleId	query	string	No	Role

Sample Response

Reponse

Status Code	Status Code Meaning	Description	Data Scheme
200	OK	Success	Inline
500	Internal Server Error	Failed	Inline

Response Structure

Status Code 200

Name	Type	Required	Constraint	Description
» code	integer	true	none	none
» data	object	true	none	none
»» id	integer	true	none	none
»» name	string	true	none	none
»» username	string	true	none	none
»» password	string	true	none	none
»» avatar	string	true	none	none
»» desc	string	true	none	none
»» age	integer	true	none	none
»» roleId	integer	true	none	none
»» updatedAt	string	true	none	none
»» createdAt	string	true	none	none

POST User Get All

POST /user/all

Show All Users

Sample Response

Reponse

Status Code	Status Code Meaning	Description	Data Scheme
200	OK	Success	Inline
500	Internal Server Error	Failed	Inline

Response Structure

Status Code 200

Name	Type	Required	Constraint	Description
» code	integer	true	none	none
» data	object	true	none	none
»» id	integer	true	none	none
»» name	string	true	none	none
»» username	string	true	none	none
»» password	string	true	none	none
»» avatar	string	true	none	none
»» desc	string	true	none	none
»» age	integer	true	none	none
»» roleId	integer	true	none	none
»» updatedAt	string	true	none	none
»» createdAt	string	true	none	none

POST User Update

POST /user/update

Update the detail of the user

Parameters

Name	Place	Type	Required	Description
name	query	string	Yes	none
username	query	string	Yes	none
password	query	string	Yes	none
avatar	query	string	No	URL of img
desc	query	string	No	description
age	query	string	No	none
roleId	query	string	No	Role
createdAt	query	string	No	Created Time
deletedAt	query	string	No	Deleted Time
role	query	string	No	Info of the editor

Sample Response

Reponse

Status Code	Status Code Meaning	Description	Data Scheme
200	OK	Success	Inline
500	Internal Server Error	Failed	Inline

Response Structure

Status Code 200

Name	Type	Required	Constraint	Description
» code	integer	true	none	none
» data	object	true	none	none
»» id	integer	true	none	none
»» name	string	true	none	none
»» username	string	true	none	none
»» password	string	true	none	none
»» avatar	string	true	none	none
»» desc	string	true	none	none
»» age	integer	true	none	none
»» roleId	integer	true	none	none
»» updatedAt	string	true	none	none
»» createdAt	string	true	none	none

POST User Delete

POST /user/del

Delete an User

Parameters

Name	Place	Type	Required	Description
name	query	string	Yes	none
username	query	string	Yes	none
password	query	string	Yes	none
avatar	query	string	No	URL of img
desc	query	string	No	description
age	query	string	No	none
roleId	query	string	No	Role
createdAt	query	string	No	Created Time
deletedAt	query	string	No	Deleted Time
role	query	string	No	Info of the editor

Sample Response

Reponse

Status Code	Status Code Meaning	Description	Data Scheme
200	OK	Success	Inline
500	Internal Server Error	Failed	Inline

Response Structure

Status Code 200

Name	Type	Required	Constraint	Description
» code	integer	true	none	none
» data	integer	true	none	none

POST User Find By ID

POST /user/findById

Find the User by User ID

Parameters

Name	Place	Type	Required	Description
id	query	string	Yes	User Id

Sample Response

Reponse

Status Code	Status Code Meaning	Description	Data Scheme
200	OK	Success	Inline
500	Internal Server Error	Failed	Inline

Response Structure

Status Code 200

Name	Type	Required	Constraint	Description
» code	integer	true	none	none
» data	object	true	none	none
»» id	integer	true	none	none
»» name	string	true	none	none
»» username	string	true	none	none
»» password	string	true	none	none
»» avatar	string	true	none	none
»» desc	string	true	none	none
»» age	integer	true	none	none
»» roleId	integer	true	none	none
»» updatedAt	string	true	none	none
»» createdAt	string	true	none	none

Category

POST Category Get All

POST /category/all

Show All Categories

Sample Response

Reponse

Status Code	Status Code Meaning	Description	Data Scheme
200	OK	Success	Inline
500	Internal Server Error	Failed	Inline

Response Structure

Status Code 200

Name	Type	Required	Constraint	Description
» code	integer	true	none	none
» data	object	true	none	none
»» rows	[object]	true	none	none
»»» id	integer	true	none	none
»»» name	string	true	none	none
»»» date	string¦null	true	none	none
»»» createdAt	string	true	none	none
»»» updatedAt	string	true	none	none
»»» deletedAt	null	true	none	none
»» count	integer	true	none	none

POST Category Delete

POST /category/del

Delete the Category

Parameters

Name	Place	Type	Required	Description
id	query	string	Yes	Category Id
name	query	string	No	Category Name
date	query	string	No	Date of the festival

Sample Response

Reponse

Status Code	Status Code Meaning	Description	Data Scheme
200	OK	Success	Inline
500	Internal Server Error	Failed	Inline

Response Structure

Status Code 200

Name	Type	Required	Constraint	Description
» code	integer	true	none	none
» data	object	true	none	none
»» id	integer	true	none	none
»» name	string	true	none	none
»» date	string	true	none	none
»» updatedAt	string	true	none	none
»» createdAt	string	true	none	none

POST Category Update

POST /category/update

Update the detail of the Category

Parameters

Name	Place	Type	Required	Description
id	query	string	Yes	Category Id
name	query	string	No	Category Name
date	query	string	No	Date of the festival
createdAt	query	string	No	Created Time
updatedAt	query	string	No	Updated Time

Sample Response

Reponse

Status Code	Status Code Meaning	Description	Data Scheme
200	OK	Success	Inline
500	Internal Server Error	Failed	Inline

Response Structure

Status Code 200

Name	Type	Required	Constraint	Description
» code	integer	true	none	none
» data	object	true	none	none
»» id	integer	true	none	none
»» name	string	true	none	none
»» date	string	true	none	none
»» updatedAt	string	true	none	none
»» createdAt	string	true	none	none

POST Category Find By ID

POST /category/findById

Find the category by category ID

Parameters

Name	Place	Type	Required	Description
id	query	string	Yes	Category Id

Sample Response

Reponse

Status Code	Status Code Meaning	Description	Data Scheme
200	OK	Success	Inline
500	Internal Server Error	Failed	Inline

Response Structure

Status Code 200

Name	Type	Required	Constraint	Description
» code	integer	true	none	none
» data	object	true	none	none
»» rows	[object]	true	none	none
»»» id	integer	false	none	none
»»» name	string	false	none	none
»»» date	string	false	none	none
»»» createdAt	string	false	none	none
»»» updatedAt	string	false	none	none
»»» deletedAt	null	false	none	none
»» count	integer	true	none	none

POST Category Add

POST /category/add

Add a new Category

Parameters

Name	Place	Type	Required	Description
id	query	string	Yes	Category Id
name	query	string	No	Category Name
date	query	string	No	Date of the festival

Sample Response

Success

{
  "code": 16,
  "data": {
    "id": 20,
    "name": "Test",
    "date": "2009-08-18",
    "updatedAt": "2004-03-01 17:23:13",
    "createdAt": "2017-05-14 22:17:48"
  }
}

Reponse

Status Code	Status Code Meaning	Description	Data Scheme
200	OK	Success	Inline
500	Internal Server Error	Failed	Inline

Response Structure

Status Code 200

Name	Type	Required	Constraint	Description
» code	integer	true	none	none
» data	object	true	none	none
»» id	integer	true	none	none
»» name	string	true	none	none
»» date	string	true	none	none
»» updatedAt	string	true	none	none
»» createdAt	string	true	none	none

Comment

POST Comment Add

POST /commentArticle/add

Add a new comment to an Article

Parameters

Name	Place	Type	Required	Description
articleId	query	string	Yes	Article ID
contnet	query	string	No	Content of comment
userId	query	string	No	Author of the Comment

Sample Response

Reponse

Status Code	Status Code Meaning	Description	Data Scheme
200	OK	Success	Inline
500	Internal Server Error	Failed	Inline

Response Structure

Status Code 200

Name	Type	Required	Constraint	Description
» code	integer	true	none	none
» data	object	true	none	none
»» id	integer	true	none	none
»» content	string	true	none	none
»» userId	integer	true	none	none
»» articleId	integer	true	none	none
»» updatedAt	string	true	none	none
»» createdAt	string	true	none	none

POST Comment Delete

POST /commentArticle/del

Delete the Comment

Parameters

Name	Place	Type	Required	Description
id	query	string	Yes	Comment Id
content	query	string	No	Content of comment
articleId	query	string	No	Article ID
article	query	string	No	Article Data
user	query	string	No	User Data
userId	query	string	No	userId

Sample Response

Reponse

Status Code	Status Code Meaning	Description	Data Scheme
200	OK	Success	Inline
500	Internal Server Error	Failed	Inline

Response Structure

Status Code 200

Name	Type	Required	Constraint	Description
» code	integer	true	none	none
» data	object	true	none	none
»» id	integer	true	none	none
»» name	string	true	none	none
»» date	string	true	none	none
»» updatedAt	string	true	none	none
»» createdAt	string	true	none	none

POST Comment Get All

POST /commentArticle/all

Show All comments

Sample Response

Reponse

Status Code	Status Code Meaning	Description	Data Scheme
200	OK	Success	Inline
500	Internal Server Error	Failed	Inline

Response Structure

Status Code 200

Name	Type	Required	Constraint	Description
» code	integer	true	none	none
» data	[object]	true	none	none
»» id	integer	true	none	none
»» name	string	true	none	none
»» content	string¦null	true	none	none
»» desc	string	true	none	none
»» userId	integer	true	none	none
»» avatar	string¦null	true	none	none
»» categoryId	integer¦null	true	none	none
»» type	null	true	none	none
»» imgs	null	true	none	none
»» frameID	string¦null	true	none	none
»» createdAt	string	true	none	none
»» updatedAt	string	true	none	none
»» deletedAt	null	true	none	none
»» category	object	true	none	none
»»» id	integer	true	none	none
»»» name	string	true	none	none
»»» date	string¦null	true	none	none
»»» createdAt	string	true	none	none
»»» updatedAt	string	true	none	none
»»» deletedAt	null	true	none	none
»» user	object	true	none	none
»»» id	integer	true	none	none
»»» name	string	true	none	none
»»» username	string	true	none	none
»»» password	string	true	none	none
»»» avatar	string¦null	true	none	none
»»» desc	string¦null	true	none	none
»»» roleId	integer	true	none	none
»»» weight	integer¦null	true	none	none
»»» age	integer	true	none	none
»»» createdAt	string	true	none	none
»»» updatedAt	string	true	none	none
»»» deletedAt	null	true	none	none
»»» role	object	true	none	none
»»»» id	integer	true	none	none
»»»» name	string	true	none	none
»»»» desc	string	true	none	none
»»»» createdAt	string	true	none	none
»»»» updatedAt	string	true	none	none
»»»» deletedAt	null	true	none	none

POST Comment List

POST /commentArticle/list

Show the requested comments details.

Parameters

Name	Place	Type	Required	Description
pageNum	query	string	Yes	Number of page
pageSize	query	string	Yes	Items per page

Sample Response

Reponse

Status Code	Status Code Meaning	Description	Data Scheme
200	OK	Success	Inline
500	Internal Server Error	Failed	Inline

Response Structure

Status Code 200

Name	Type	Required	Constraint	Description
» code	integer	true	none	none
» data	object	true	none	none
»» rows	[object]	true	none	none
»»» id	integer	false	none	none
»»» content	string	false	none	none
»»» userId	integer	false	none	none
»»» articleId	integer	false	none	none
»»» createdAt	string	false	none	none
»»» updatedAt	string	false	none	none
»»» deletedAt	null	false	none	none
»»» user	object	false	none	none
»»»» id	integer	true	none	none
»»»» name	string	true	none	none
»»»» username	string	true	none	none
»»»» password	string	true	none	none
»»»» avatar	string	true	none	none
»»»» desc	string	true	none	none
»»»» roleId	integer	true	none	none
»»»» weight	integer	true	none	none
»»»» age	integer	true	none	none
»»»» createdAt	string	true	none	none
»»»» updatedAt	string	true	none	none
»»»» deletedAt	null	true	none	none
»»»» role	object	true	none	none
»»»»» id	integer	true	none	none
»»»»» name	string	true	none	none
»»»»» desc	string	true	none	none
»»»»» createdAt	string	true	none	none
»»»»» updatedAt	string	true	none	none
»»»»» deletedAt	null	true	none	none
»»» article	object	false	none	none
»»»» id	integer	true	none	none
»»»» name	string	true	none	none
»»»» content	string	true	none	none
»»»» desc	string	true	none	none
»»»» userId	integer	true	none	none
»»»» avatar	string	true	none	none
»»»» categoryId	integer	true	none	none
»»»» type	null	true	none	none
»»»» imgs	null	true	none	none
»»»» frameID	string	true	none	none
»»»» createdAt	string	true	none	none
»»»» updatedAt	string	true	none	none
»»»» deletedAt	null	true	none	none
»»»» category	object	true	none	none
»»»»» id	integer	true	none	none
»»»»» name	string	true	none	none
»»»»» date	string	true	none	none
»»»»» createdAt	string	true	none	none
»»»»» updatedAt	string	true	none	none
»»»»» deletedAt	null	true	none	none
»»»» user	object	true	none	none
»»»»» id	integer	true	none	none
»»»»» name	string	true	none	none
»»»»» username	string	true	none	none
»»»»» password	string	true	none	none
»»»»» avatar	string	true	none	none
»»»»» desc	string	true	none	none
»»»»» roleId	integer	true	none	none
»»»»» weight	integer	true	none	none
»»»»» age	integer	true	none	none
»»»»» createdAt	string	true	none	none
»»»»» updatedAt	string	true	none	none
»»»»» deletedAt	null	true	none	none
»»»»» role	object	true	none	none
»»»»»» id	integer	true	none	none
»»»»»» name	string	true	none	none
»»»»»» desc	string	true	none	none
»»»»»» createdAt	string	true	none	none
»»»»»» updatedAt	string	true	none	none
»»»»»» deletedAt	null	true	none	none
»» count	integer	true	none	none

POST Comment Find By ID

POST /Comment/findById

Find the Comment by Comment ID

Parameters

Name	Place	Type	Required	Description
id	query	string	Yes	Category Id

Sample Response

Reponse

Status Code	Status Code Meaning	Description	Data Scheme
200	OK	Success	Inline
500	Internal Server Error	Failed	Inline

Response Structure

Status Code 200

Name	Type	Required	Constraint	Description
» code	integer	true	none	none
» data	object	true	none	none
»» rows	[object]	true	none	none
»»» id	integer	false	none	none
»»» name	string	false	none	none
»»» date	string	false	none	none
»»» createdAt	string	false	none	none
»»» updatedAt	string	false	none	none
»»» deletedAt	null	false	none	none
»» count	integer	true	none	none

POST Comment Update

POST /commentArticle/update

Delete the Comment

Parameters

Name	Place	Type	Required	Description
id	query	string	Yes	Comment Id
userId	query	string	No	userId
content	query	string	No	Content of comment
articleId	query	string	No	Article ID
article	query	string	No	Article Data
user	query	string	No	User Data

Sample Response

Reponse

Status Code	Status Code Meaning	Description	Data Scheme
200	OK	Success	Inline
500	Internal Server Error	Failed	Inline

Response Structure

Status Code 200

Name	Type	Required	Constraint	Description
» code	integer	true	none	none
» data	object	true	none	none
»» id	integer	true	none	none
»» name	string	true	none	none
»» date	string	true	none	none
»» updatedAt	string	true	none	none
»» createdAt	string	true	none	none

Collection

POST Collection Add

POST /collection/add

Add a new Collection to an User

Parameters

Name	Place	Type	Required	Description
id	query	string	Yes	Saved Id
userId	query	string	Yes	User Id
articleId	query	string	Yes	Article Id
updatedAt	query	string	No	Updated Time
createdAt	query	string	No	Created Time

Sample Response

Reponse

Status Code	Status Code Meaning	Description	Data Scheme
200	OK	Success	Inline
500	Internal Server Error	Failed	Inline

Response Structure

Status Code 200

Name	Type	Required	Constraint	Description
» code	integer	true	none	none
» data	object	true	none	none
»» id	integer	true	none	none
»» userId	integer	true	none	none
»» articleId	integer	true	none	none
»» updatedAt	string	true	none	none
»» createdAt	string	true	none	none

POST Comment List

POST /collection/list

Show the requested Collections details.

Parameters

Name	Place	Type	Required	Description
pageNum	query	string	Yes	Number of page
pageSize	query	string	Yes	Items per page

Sample Response

Reponse

Status Code	Status Code Meaning	Description	Data Scheme
200	OK	Success	Inline
500	Internal Server Error	Failed	Inline

Response Structure

Status Code 200

Name	Type	Required	Constraint	Description
» code	integer	true	none	none
» data	object	true	none	none
»» rows	[object]	true	none	none
»»» id	integer	false	none	none
»»» userId	integer	false	none	none
»»» articleId	integer	false	none	none
»»» createdAt	string	false	none	none
»»» updatedAt	string	false	none	none
»»» deletedAt	null	false	none	none
»»» user	object	false	none	none
»»»» id	integer	true	none	none
»»»» name	string	true	none	none
»»»» username	string	true	none	none
»»»» password	string	true	none	none
»»»» avatar	null	true	none	none
»»»» desc	null	true	none	none
»»»» roleId	null	true	none	none
»»»» weight	null	true	none	none
»»»» age	null	true	none	none
»»»» createdAt	string	true	none	none
»»»» updatedAt	string	true	none	none
»»»» deletedAt	null	true	none	none
»»» article	object	false	none	none
»»»» id	integer	true	none	none
»»»» name	string	true	none	none
»»»» content	string	true	none	none
»»»» desc	string	true	none	none
»»»» userId	integer	true	none	none
»»»» avatar	string	true	none	none
»»»» categoryId	integer	true	none	none
»»»» type	null	true	none	none
»»»» imgs	null	true	none	none
»»»» frameID	string	true	none	none
»»»» createdAt	string	true	none	none
»»»» updatedAt	string	true	none	none
»»»» deletedAt	null	true	none	none
»»»» category	object	true	none	none
»»»»» id	integer	true	none	none
»»»»» name	string	true	none	none
»»»»» date	string	true	none	none
»»»»» createdAt	string	true	none	none
»»»»» updatedAt	string	true	none	none
»»»»» deletedAt	null	true	none	none
»»»» user	object	true	none	none
»»»»» id	integer	true	none	none
»»»»» name	string	true	none	none
»»»»» username	string	true	none	none
»»»»» password	string	true	none	none
»»»»» avatar	string	true	none	none
»»»»» desc	string	true	none	none
»»»»» roleId	integer	true	none	none
»»»»» weight	integer	true	none	none
»»»»» age	integer	true	none	none
»»»»» createdAt	string	true	none	none
»»»»» updatedAt	string	true	none	none
»»»»» deletedAt	null	true	none	none
»»»»» role	object	true	none	none
»»»»»» id	integer	true	none	none
»»»»»» name	string	true	none	none
»»»»»» desc	string	true	none	none
»»»»»» createdAt	string	true	none	none
»»»»»» updatedAt	string	true	none	none
»»»»»» deletedAt	null	true	none	none
»» count	integer	true	none	none

POST Collection Find By ID

POST /collection/findById

Find the Collection by Collection ID

Parameters

Name	Place	Type	Required	Description
id	query	string	Yes	Collection Id

Sample Response

Reponse

Status Code	Status Code Meaning	Description	Data Scheme
200	OK	Success	Inline
500	Internal Server Error	Failed	Inline

Response Structure

Status Code 200

Name	Type	Required	Constraint	Description
» code	integer	true	none	none
» data	object	true	none	none
»» rows	[object]	true	none	none
»»» id	integer	true	none	none
»»» userId	integer	true	none	none
»»» articleId	integer	true	none	none
»»» createdAt	string	true	none	none
»»» updatedAt	string	true	none	none
»»» deletedAt	null	true	none	none
»»» user	object	true	none	none
»»»» id	integer	true	none	none
»»»» name	string	true	none	none
»»»» username	string	true	none	none
»»»» password	string	true	none	none
»»»» avatar	string¦null	true	none	none
»»»» desc	string¦null	true	none	none
»»»» roleId	integer¦null	true	none	none
»»»» weight	integer¦null	true	none	none
»»»» age	integer¦null	true	none	none
»»»» createdAt	string	true	none	none
»»»» updatedAt	string	true	none	none
»»»» deletedAt	null	true	none	none
»»»» role	object	false	none	none
»»»»» id	integer	true	none	none
»»»»» name	string	true	none	none
»»»»» desc	string	true	none	none
»»»»» createdAt	string	true	none	none
»»»»» updatedAt	string	true	none	none
»»»»» deletedAt	null	true	none	none
»»» article	object	true	none	none
»»»» id	integer	true	none	none
»»»» name	string	true	none	none
»»»» content	string	true	none	none
»»»» desc	string	true	none	none
»»»» userId	integer	true	none	none
»»»» avatar	string	true	none	none
»»»» categoryId	integer	true	none	none
»»»» type	null	true	none	none
»»»» imgs	null	true	none	none
»»»» frameID	string	true	none	none
»»»» createdAt	string	true	none	none
»»»» updatedAt	string	true	none	none
»»»» deletedAt	null	true	none	none
»»»» category	object	true	none	none
»»»»» id	integer	true	none	none
»»»»» name	string	true	none	none
»»»»» date	string	true	none	none
»»»»» createdAt	string	true	none	none
»»»»» updatedAt	string	true	none	none
»»»»» deletedAt	null	true	none	none
»»»» user	object	true	none	none
»»»»» id	integer	true	none	none
»»»»» name	string	true	none	none
»»»»» username	string	true	none	none
»»»»» password	string	true	none	none
»»»»» avatar	string	true	none	none
»»»»» desc	string	true	none	none
»»»»» roleId	integer	true	none	none
»»»»» weight	integer	true	none	none
»»»»» age	integer	true	none	none
»»»»» createdAt	string	true	none	none
»»»»» updatedAt	string	true	none	none
»»»»» deletedAt	null	true	none	none
»»»»» role	object	true	none	none
»»»»»» id	integer	true	none	none
»»»»»» name	string	true	none	none
»»»»»» desc	string	true	none	none
»»»»»» createdAt	string	true	none	none
»»»»»» updatedAt	string	true	none	none
»»»»»» deletedAt	null	true	none	none
»» count	integer	true	none	none

POST Collection Delete

POST /collection/del

Delete a Collection

Parameters

Name	Place	Type	Required	Description
id	query	string	Yes	Collection ID
userId	query	string	No	User ID
articleId	query	string	No	Article ID
article	query	string	No	Article Data
user	query	string	No	User Data

Sample Response

Reponse

Status Code	Status Code Meaning	Description	Data Scheme
200	OK	Success	Inline
500	Internal Server Error	Failed	Inline

Response Structure

Status Code 200

Name	Type	Required	Constraint	Description
» code	integer	true	none	none
» data	integer	true	none	none

POST Collection Update

POST /collection/update

Update a Collection to an User

Parameters

Name	Place	Type	Required	Description
id	query	string	Yes	Saved Id
userId	query	string	Yes	User Id
articleId	query	string	Yes	Article Id
updatedAt	query	string	No	Updated Time
createdAt	query	string	No	Created Time
article	query	string	No	Article Data
user	query	string	No	User Data

Sample Response

Reponse

Status Code	Status Code Meaning	Description	Data Scheme
200	OK	Success	Inline
500	Internal Server Error	Failed	Inline

Response Structure

Status Code 200

Name	Type	Required	Constraint	Description
» code	integer	true	none	none
» data	object	true	none	none
»» id	integer	true	none	none
»» userId	integer	true	none	none
»» articleId	integer	true	none	none
»» updatedAt	string	true	none	none
»» createdAt	string	true	none	none

POST Collection Get All

POST /collection/all

Show All collections

Sample Response

Reponse

Status Code	Status Code Meaning	Description	Data Scheme
200	OK	Success	Inline
500	Internal Server Error	Failed	Inline

Response Structure

Status Code 200

Name	Type	Required	Constraint	Description
» code	integer	true	none	none
» data	[object]	true	none	none
»» id	integer	true	none	none
»» name	string	true	none	none
»» username	string	true	none	none
»» password	string	true	none	none
»» avatar	string¦null	true	none	none
»» desc	string¦null	true	none	none
»» roleId	integer¦null	true	none	none
»» weight	integer¦null	true	none	none
»» age	integer¦null	true	none	none
»» createdAt	string	true	none	none
»» updatedAt	string	true	none	none
»» deletedAt	null	true	none	none
»» role	object¦null	true	none	none
»»» id	integer	true	none	none
»»» name	string	true	none	none
»»» desc	string	true	none	none
»»» createdAt	string	true	none	none
»»» updatedAt	string	true	none	none
»»» deletedAt	null	true	none	none

Likes

POST Like Add

POST /likeArticle/add

Add a new Like to an User

Parameters

Name	Place	Type	Required	Description
id	query	string	Yes	Like Id
userId	query	string	Yes	User Id
articleId	query	string	Yes	Article Id
updatedAt	query	string	No	Updated Time
createdAt	query	string	No	Created Time

Sample Response

Reponse

Status Code	Status Code Meaning	Description	Data Scheme
200	OK	Success	Inline
500	Internal Server Error	Failed	Inline

Response Structure

Status Code 200

Name	Type	Required	Constraint	Description
» code	integer	true	none	none
» data	object	true	none	none
»» id	integer	true	none	none
»» userId	integer	true	none	none
»» articleId	integer	true	none	none
»» updatedAt	string	true	none	none
»» createdAt	string	true	none	none

POST LikeUpdate

POST /likeArticle/update

Update a Like to an User

Parameters

Name	Place	Type	Required	Description
id	query	string	Yes	Saved Id
userId	query	string	Yes	User Id
articleId	query	string	Yes	Article Id
updatedAt	query	string	No	Updated Time
createdAt	query	string	No	Created Time
article	query	string	No	Article Data
user	query	string	No	User Data

Sample Response

Reponse

Status Code	Status Code Meaning	Description	Data Scheme
200	OK	Success	Inline
500	Internal Server Error	Failed	Inline

Response Structure

Status Code 200

Name	Type	Required	Constraint	Description
» code	integer	true	none	none
» data	object	true	none	none
»» id	integer	true	none	none
»» userId	integer	true	none	none
»» articleId	integer	true	none	none
»» updatedAt	string	true	none	none
»» createdAt	string	true	none	none

POST Like Delete

POST /likeArticle/del

Delete a Like

Parameters

Name	Place	Type	Required	Description
id	query	string	Yes	Like ID
userId	query	string	No	User ID
articleId	query	string	No	Article ID
article	query	string	No	Article Data
user	query	string	No	User Data

Sample Response

Reponse

Status Code	Status Code Meaning	Description	Data Scheme
200	OK	Success	Inline
500	Internal Server Error	Failed	Inline

Response Structure

Status Code 200

Name	Type	Required	Constraint	Description
» code	integer	true	none	none
» data	integer	true	none	none

POST Like Find By ID

POST /likeArticle/findById

Find the Collection by Like ID

Parameters

Name	Place	Type	Required	Description
id	query	string	Yes	Like Id

Sample Response

Reponse

Status Code	Status Code Meaning	Description	Data Scheme
200	OK	Success	Inline
500	Internal Server Error	Failed	Inline

Response Structure

Status Code 200

Name	Type	Required	Constraint	Description
» code	integer	true	none	none
» data	object	true	none	none
»» rows	[object]	true	none	none
»»» id	integer	true	none	none
»»» userId	integer	true	none	none
»»» articleId	integer	true	none	none
»»» createdAt	string	true	none	none
»»» updatedAt	string	true	none	none
»»» deletedAt	null	true	none	none
»»» user	object	true	none	none
»»»» id	integer	true	none	none
»»»» name	string	true	none	none
»»»» username	string	true	none	none
»»»» password	string	true	none	none
»»»» avatar	string¦null	true	none	none
»»»» desc	string¦null	true	none	none
»»»» roleId	integer¦null	true	none	none
»»»» weight	integer¦null	true	none	none
»»»» age	integer¦null	true	none	none
»»»» createdAt	string	true	none	none
»»»» updatedAt	string	true	none	none
»»»» deletedAt	null	true	none	none
»»»» role	object	false	none	none
»»»»» id	integer	true	none	none
»»»»» name	string	true	none	none
»»»»» desc	string	true	none	none
»»»»» createdAt	string	true	none	none
»»»»» updatedAt	string	true	none	none
»»»»» deletedAt	null	true	none	none
»»» article	object	true	none	none
»»»» id	integer	true	none	none
»»»» name	string	true	none	none
»»»» content	string	true	none	none
»»»» desc	string	true	none	none
»»»» userId	integer	true	none	none
»»»» avatar	string	true	none	none
»»»» categoryId	integer	true	none	none
»»»» type	null	true	none	none
»»»» imgs	null	true	none	none
»»»» frameID	string	true	none	none
»»»» createdAt	string	true	none	none
»»»» updatedAt	string	true	none	none
»»»» deletedAt	null	true	none	none
»»»» category	object	true	none	none
»»»»» id	integer	true	none	none
»»»»» name	string	true	none	none
»»»»» date	string	true	none	none
»»»»» createdAt	string	true	none	none
»»»»» updatedAt	string	true	none	none
»»»»» deletedAt	null	true	none	none
»»»» user	object	true	none	none
»»»»» id	integer	true	none	none
»»»»» name	string	true	none	none
»»»»» username	string	true	none	none
»»»»» password	string	true	none	none
»»»»» avatar	string	true	none	none
»»»»» desc	string	true	none	none
»»»»» roleId	integer	true	none	none
»»»»» weight	integer	true	none	none
»»»»» age	integer	true	none	none
»»»»» createdAt	string	true	none	none
»»»»» updatedAt	string	true	none	none
»»»»» deletedAt	null	true	none	none
»»»»» role	object	true	none	none
»»»»»» id	integer	true	none	none
»»»»»» name	string	true	none	none
»»»»»» desc	string	true	none	none
»»»»»» createdAt	string	true	none	none
»»»»»» updatedAt	string	true	none	none
»»»»»» deletedAt	null	true	none	none
»» count	integer	true	none	none

POST Like Get All

POST /likeArticle/all

Show All Likes

Sample Response

Reponse

Status Code	Status Code Meaning	Description	Data Scheme
200	OK	Success	Inline
500	Internal Server Error	Failed	Inline

Response Structure

Status Code 200

Name	Type	Required	Constraint	Description
» code	integer	true	none	none
» data	[object]	true	none	none
»» id	integer	true	none	none
»» name	string	true	none	none
»» username	string	true	none	none
»» password	string	true	none	none
»» avatar	string¦null	true	none	none
»» desc	string¦null	true	none	none
»» roleId	integer¦null	true	none	none
»» weight	integer¦null	true	none	none
»» age	integer¦null	true	none	none
»» createdAt	string	true	none	none
»» updatedAt	string	true	none	none
»» deletedAt	null	true	none	none
»» role	object¦null	true	none	none
»»» id	integer	true	none	none
»»» name	string	true	none	none
»»» desc	string	true	none	none
»»» createdAt	string	true	none	none
»»» updatedAt	string	true	none	none
»»» deletedAt	null	true	none	none

POST Like List

POST /likeArticle/list

Show the requested Likes details.

Parameters

Name	Place	Type	Required	Description
pageNum	query	string	Yes	Number of page
pageSize	query	string	Yes	Items per page

Sample Response

Reponse

Status Code	Status Code Meaning	Description	Data Scheme
200	OK	Success	Inline
500	Internal Server Error	Failed	Inline

Response Structure

Status Code 200

Name	Type	Required	Constraint	Description
» code	integer	true	none	none
» data	object	true	none	none
»» rows	[object]	true	none	none
»»» id	integer	false	none	none
»»» userId	integer	false	none	none
»»» articleId	integer	false	none	none
»»» createdAt	string	false	none	none
»»» updatedAt	string	false	none	none
»»» deletedAt	null	false	none	none
»»» user	object	false	none	none
»»»» id	integer	true	none	none
»»»» name	string	true	none	none
»»»» username	string	true	none	none
»»»» password	string	true	none	none
»»»» avatar	null	true	none	none
»»»» desc	null	true	none	none
»»»» roleId	null	true	none	none
»»»» weight	null	true	none	none
»»»» age	null	true	none	none
»»»» createdAt	string	true	none	none
»»»» updatedAt	string	true	none	none
»»»» deletedAt	null	true	none	none
»»» article	object	false	none	none
»»»» id	integer	true	none	none
»»»» name	string	true	none	none
»»»» content	string	true	none	none
»»»» desc	string	true	none	none
»»»» userId	integer	true	none	none
»»»» avatar	string	true	none	none
»»»» categoryId	integer	true	none	none
»»»» type	null	true	none	none
»»»» imgs	null	true	none	none
»»»» frameID	string	true	none	none
»»»» createdAt	string	true	none	none
»»»» updatedAt	string	true	none	none
»»»» deletedAt	null	true	none	none
»»»» category	object	true	none	none
»»»»» id	integer	true	none	none
»»»»» name	string	true	none	none
»»»»» date	string	true	none	none
»»»»» createdAt	string	true	none	none
»»»»» updatedAt	string	true	none	none
»»»»» deletedAt	null	true	none	none
»»»» user	object	true	none	none
»»»»» id	integer	true	none	none
»»»»» name	string	true	none	none
»»»»» username	string	true	none	none
»»»»» password	string	true	none	none
»»»»» avatar	string	true	none	none
»»»»» desc	string	true	none	none
»»»»» roleId	integer	true	none	none
»»»»» weight	integer	true	none	none
»»»»» age	integer	true	none	none
»»»»» createdAt	string	true	none	none
»»»»» updatedAt	string	true	none	none
»»»»» deletedAt	null	true	none	none
»»»»» role	object	true	none	none
»»»»»» id	integer	true	none	none
»»»»»» name	string	true	none	none
»»»»»» desc	string	true	none	none
»»»»»» createdAt	string	true	none	none
»»»»»» updatedAt	string	true	none	none
»»»»»» deletedAt	null	true	none	none
»» count	integer	true	none	none

Articles

POST Article Find By ID

POST /article/findById

Find the article by Article ID

Parameters

Name	Place	Type	Required	Description
id	query	string	Yes	User Id

Sample Response

Reponse

Status Code	Status Code Meaning	Description	Data Scheme
200	OK	Success	Inline
500	Internal Server Error	Failed	Inline

Response Structure

Status Code 200

Name	Type	Required	Constraint	Description
» code	integer	true	none	none
» data	object	true	none	none
»» id	integer	true	none	none
»» userId	integer	true	none	none
»» name	string	true	none	none
»» desc	string	true	none	none
»» content	string	true	none	none
»» categoryId	string	true	none	none
»» type	string	true	none	none
»» avatar	string	true	none	none
»» imgs	string	true	none	none
»» frameID	string	true	none	none
»» updatedAt	string	true	none	none
»» createdAt	string	true	none	none

POST Article List

POST /article/list

Show the requested article details

Parameters

Name	Place	Type	Required	Description
pageNum	query	string	Yes	Number of page
pageSize	query	string	Yes	Items per page

Sample Response

Reponse

Status Code	Status Code Meaning	Description	Data Scheme
200	OK	Success	Inline
500	Internal Server Error	Failed	Inline

Response Structure

Status Code 200

Name	Type	Required	Constraint	Description
» code	integer	true	none	none
» data	object	true	none	none
»» id	integer	true	none	none
»» name	string	true	none	none
»» username	string	true	none	none
»» password	string	true	none	none
»» avatar	string	true	none	none
»» desc	string	true	none	none
»» age	integer	true	none	none
»» roleId	integer	true	none	none
»» updatedAt	string	true	none	none
»» createdAt	string	true	none	none

POST Article Update

POST /article/update

Update an Article

Parameters

Name	Place	Type	Required	Description
id	query	string	Yes	Article ID
name	query	string	Yes	Article Title
desc	query	string	No	Description
content	query	string	No	HTML Content
userId	query	string	No	User ID
categoryId	query	string	No	Category ID
avatar	query	string	No	Banner Image
type	query	string	No	File Type
imgs	query	string	No	Images List
frameID	query	string	No	PlugXR ID

Sample Response

Reponse

Status Code	Status Code Meaning	Description	Data Scheme
200	OK	Success	Inline
500	Internal Server Error	Failed	Inline

Response Structure

Status Code 200

Name	Type	Required	Constraint	Description
» code	integer	true	none	none
» data	object	true	none	none
»» id	integer	true	none	none
»» userId	integer	true	none	none
»» name	string	true	none	none
»» desc	string	true	none	none
»» content	string	true	none	none
»» categoryId	string	true	none	none
»» type	string	true	none	none
»» avatar	string	true	none	none
»» imgs	string	true	none	none
»» frameID	string	true	none	none
»» updatedAt	string	true	none	none
»» createdAt	string	true	none	none

POST Article Add

POST /article/add

Add an new Article

Parameters

Name	Place	Type	Required	Description
id	query	string	Yes	Article ID
name	query	string	Yes	Article Title
desc	query	string	No	Description
content	query	string	No	HTML Content
userId	query	string	No	User ID
categoryId	query	string	No	Category ID
avatar	query	string	No	Banner Image
type	query	string	No	File Type
imgs	query	string	No	Images List
frameID	query	string	No	PlugXR ID

Sample Response

Reponse

Status Code	Status Code Meaning	Description	Data Scheme
200	OK	Success	Inline
500	Internal Server Error	Failed	Inline

Response Structure

Status Code 200

Name	Type	Required	Constraint	Description
» code	integer	true	none	none
» data	object	true	none	none
»» id	integer	true	none	none
»» userId	integer	true	none	none
»» name	string	true	none	none
»» desc	string	true	none	none
»» content	string	true	none	none
»» categoryId	string	true	none	none
»» type	string	true	none	none
»» avatar	string	true	none	none
»» imgs	string	true	none	none
»» frameID	string	true	none	none
»» updatedAt	string	true	none	none
»» createdAt	string	true	none	none

POST Article Get All

POST /article/all

Show All Articles

Sample Response

Reponse

Status Code	Status Code Meaning	Description	Data Scheme
200	OK	Success	Inline
500	Internal Server Error	Failed	Inline

Response Structure

Status Code 200

Name	Type	Required	Constraint	Description
» code	integer	true	none	none
» data	[object]	true	none	none
»» id	integer	true	none	none
»» name	string	true	none	none
»» username	string	true	none	none
»» password	string	true	none	none
»» avatar	string¦null	true	none	none
»» desc	string¦null	true	none	none
»» roleId	integer¦null	true	none	none
»» weight	integer¦null	true	none	none
»» age	integer¦null	true	none	none
»» createdAt	string	true	none	none
»» updatedAt	string	true	none	none
»» deletedAt	null	true	none	none
»» role	object¦null	true	none	none
»»» id	integer	true	none	none
»»» name	string	true	none	none
»»» desc	string	true	none	none
»»» createdAt	string	true	none	none
»»» updatedAt	string	true	none	none
»»» deletedAt	null	true	none	none

POST Article Delete

POST /article/del

Delete an Article

Parameters

Name	Place	Type	Required	Description
id	query	string	Yes	Article ID
name	query	string	No	Article Title
desc	query	string	No	Description
content	query	string	No	HTML Content
userId	query	string	No	User ID
categoryId	query	string	No	Category ID
avatar	query	string	No	Banner Image
type	query	string	No	File Type
imgs	query	string	No	Images List
frameID	query	string	No	PlugXR ID
createdAt	query	string	No	Created Time
updatedAt	query	string	No	Updated Time

Sample Response

Reponse

Status Code	Status Code Meaning	Description	Data Scheme
200	OK	Success	Inline
500	Internal Server Error	Failed	Inline

Response Structure

Status Code 200

Name	Type	Required	Constraint	Description
» code	integer	true	none	none
» data	object	true	none	none
»» id	integer	true	none	none
»» userId	integer	true	none	none
»» name	string	true	none	none
»» desc	string	true	none	none
»» content	string	true	none	none
»» categoryId	string	true	none	none
»» type	string	true	none	none
»» avatar	string	true	none	none
»» imgs	string	true	none	none
»» frameID	string	true	none	none
»» updatedAt	string	true	none	none
»» createdAt	string	true	none	none

Data Scheme

Comment

[
  {
    "id": 0,
    "name": "string",
    "username": "string",
    "password": "string",
    "avatar": "string",
    "desc": "string",
    "roleId": 0,
    "weight": 0,
    "age": 0,
    "createdAt": "string",
    "updatedAt": "string",
    "deletedAt": null,
    "role": {
      "id": 0,
      "name": "string",
      "desc": "string",
      "createdAt": "string",
      "updatedAt": "string",
      "deletedAt": null
    }
  }
]

property

Name	Type	Required	Constraint	Description
id	integer	true	none	none
name	string	true	none	none
username	string	true	none	none
password	string	true	none	none
avatar	string¦null	true	none	none
desc	string¦null	true	none	none
roleId	integer¦null	true	none	none
weight	integer¦null	true	none	none
age	integer¦null	true	none	none
createdAt	string	true	none	none
updatedAt	string	true	none	none
deletedAt	null	true	none	none
role	object¦null	true	none	none
» id	integer	true	none	none
» name	string	true	none	none
» desc	string	true	none	none
» createdAt	string	true	none	none
» updatedAt	string	true	none	none
» deletedAt	null	true	none	none

Category

[
  {
    "id": 0,
    "name": "string",
    "date": "string",
    "createdAt": "string",
    "updatedAt": "string",
    "deletedAt": null
  }
]

property

Name	Type	Required	Constraint	Description
id	integer	true	none	none
name	string	true	none	none
date	string¦null	true	none	none
createdAt	string	true	none	none
updatedAt	string	true	none	none
deletedAt	null	true	none	none

User

{
  "data": {
    "id": 0,
    "name": "string",
    "username": "string",
    "password": "string",
    "avatar": "string",
    "desc": "string",
    "age": 0,
    "roleId": 0,
    "updatedAt": "string",
    "createdAt": "string"
  }
}

property

Name	Type	Required	Constraint	Description
data	object	true	none	none
» id	integer	true	none	none
» name	string	true	none	none
» username	string	true	none	none
» password	string	true	none	none
» avatar	string	true	none	none
» desc	string	true	none	none
» age	integer	true	none	none
» roleId	integer	true	none	none
» updatedAt	string	true	none	none
» createdAt	string	true	none	none

Collection

[
  {
    "id": 0,
    "name": "string",
    "username": "string",
    "password": "string",
    "avatar": "string",
    "desc": "string",
    "roleId": 0,
    "weight": 0,
    "age": 0,
    "createdAt": "string",
    "updatedAt": "string",
    "deletedAt": null,
    "role": {
      "id": 0,
      "name": "string",
      "desc": "string",
      "createdAt": "string",
      "updatedAt": "string",
      "deletedAt": null
    }
  }
]

property

Name	Type	Required	Constraint	Description
id	integer	true	none	none
name	string	true	none	none
username	string	true	none	none
password	string	true	none	none
avatar	string¦null	true	none	none
desc	string¦null	true	none	none
roleId	integer¦null	true	none	none
weight	integer¦null	true	none	none
age	integer¦null	true	none	none
createdAt	string	true	none	none
updatedAt	string	true	none	none
deletedAt	null	true	none	none
role	object¦null	true	none	none
» id	integer	true	none	none
» name	string	true	none	none
» desc	string	true	none	none
» createdAt	string	true	none	none
» updatedAt	string	true	none	none
» deletedAt	null	true	none	none

Article

[
  {
    "id": 0,
    "name": "string",
    "username": "string",
    "password": "string",
    "avatar": "string",
    "desc": "string",
    "roleId": 0,
    "weight": 0,
    "age": 0,
    "createdAt": "string",
    "updatedAt": "string",
    "deletedAt": null,
    "role": {
      "id": 0,
      "name": "string",
      "desc": "string",
      "createdAt": "string",
      "updatedAt": "string",
      "deletedAt": null
    }
  }
]

property

Name	Type	Required	Constraint	Description
id	integer	true	none	none
name	string	true	none	none
username	string	true	none	none
password	string	true	none	none
avatar	string¦null	true	none	none
desc	string¦null	true	none	none
roleId	integer¦null	true	none	none
weight	integer¦null	true	none	none
age	integer¦null	true	none	none
createdAt	string	true	none	none
updatedAt	string	true	none	none
deletedAt	null	true	none	none
role	object¦null	true	none	none
» id	integer	true	none	none
» name	string	true	none	none
» desc	string	true	none	none
» createdAt	string	true	none	none
» updatedAt	string	true	none	none
» deletedAt	null	true	none	none

Likes

[
  {
    "id": 0,
    "name": "string",
    "username": "string",
    "password": "string",
    "avatar": "string",
    "desc": "string",
    "roleId": 0,
    "weight": 0,
    "age": 0,
    "createdAt": "string",
    "updatedAt": "string",
    "deletedAt": null,
    "role": {
      "id": 0,
      "name": "string",
      "desc": "string",
      "createdAt": "string",
      "updatedAt": "string",
      "deletedAt": null
    }
  }
]

property

Name	Type	Required	Constraint	Description
id	integer	true	none	none
name	string	true	none	none
username	string	true	none	none
password	string	true	none	none
avatar	string¦null	true	none	none
desc	string¦null	true	none	none
roleId	integer¦null	true	none	none
weight	integer¦null	true	none	none
age	integer¦null	true	none	none
createdAt	string	true	none	none
updatedAt	string	true	none	none
deletedAt	null	true	none	none
role	object¦null	true	none	none
» id	integer	true	none	none
» name	string	true	none	none
» desc	string	true	none	none
» createdAt	string	true	none	none
» updatedAt	string	true	none	none
» deletedAt	null	true	none	none