Skip to content

Latest commit

 

History

History
149 lines (100 loc) · 2.8 KB

comment.md

File metadata and controls

149 lines (100 loc) · 2.8 KB

Comments

(B0) POST /comment/:repname/:itemname

说明

【用户】对一个dataitem发表一个评论 (欲评论,先订阅)

输入参数说明:

token: 一个隐藏的防止重复发表的token。此token由前端生成,最好是一个uuid,可用这个库: https://github.com/broofa/node-uuid
replyto: 被回复的评论id (0表示未回复任何评论, 只有dataitem creator可以回复)
content: 评论内容(最多2000字节,或1000汉字)

输入样例:

POST /comment/repo1/item123 HTTP/1.1 
Accept: application/json
Authorization: Token dcabfefb6ad8feb68e6fbce876fbfe778fb

{
	"token": "a1a2a3a4a5a6a7a8",
	"replyto": 0,
	"content": "bla bla ..."
}

输出样例:

"commentid" : 1234567

(B1) PUT /comment/:repname/:itemname

说明

【用户】修改自己对一个dataitem的评论

输入参数说明:

commentid: 将被修改的评论id
content: 更新后的内容

输入样例:

PUT /comment/repo1/item123 HTTP/1.1 
Accept: application/json
Authorization: Token dcabfefb6ad8feb68e6fbce876fbfe778fb

{
	"commentid": 123456,
	"content": "bla bla ..."
}

输出样例:

(空)

(B2) DELETE /comment/:repname/:itemname?commentid={commentid}

说明

【用户】删除自己对一个dataitem的评论

输入参数说明:

输入样例:

DELETE /comment/repo1/item123?commentid=1234567 HTTP/1.1 
Accept: application/json
Authorization: Token dcabfefb6ad8feb68e6fbce876fbfe778fb

输出样例:

(空)

(B3) GET /comments/:repname/:itemname?page={page}&size={size}

说明

【任何】返回一个dataitem上的评论列表

输入参数说明:

page: (可选) 第几页,最小值为1
size: (可选) 每页最多返回多少条数据

输入样例:

GET /comments/repo1/item123?beforetime=2015-11-23T09:02:52Z HTTP/1.1 
Accept: application/json

输出样例:

{
	"total": 100,
	"results": [
		{
			"commentid": 1234567,
			"username": "[email protected]",
			"nickname", "老张",
			"createtime": "2015-11-10T15:04:05Z08:00",
			"content": "bla bla ...",
			"replyto": {
				"commentid": 1234560,
				"username": "[email protected]",
				"nickname", "小李",
				"content": "cool data! ..."
			}
		},
		{
			"commentid": 1234568,
			"username": "[email protected]",
			"nickname", "小李",
			"createtime": "2015-11-10T15:04:09Z08:00",
			"content": "bla bla ...",
			"replyto": null
		},
		{
			"commentid": 1234569,
			"username": "[email protected]",
			"nickname", "小李",
			"createtime": "2015-11-10T15:06:09Z08:00",
			"content": "bla bla ...",
			"replyto": null
		}
	]
}

(B4) GET /comment_stat/:repname/:itemname

说明

【任何】返回一个dataitem上的评论数

输入参数说明:

输入样例:

GET /comment_stat/repo1/item123 HTTP/1.1 
Accept: application/json

输出样例:

numcomments: 33