Skip to content

Latest commit

 

History

History
259 lines (221 loc) · 7.33 KB

COMMUNITY.md

File metadata and controls

259 lines (221 loc) · 7.33 KB
Raw

主菜单

公共社区接口说明

公共社区系统提供用户发表公开信息功能（publication），目前该系统仅支持通过HTTP请求访问，并使用PUT方法
其子类型包括：
用户提问（question）
用户回答（answer）
发表文章（article）
发表想法（thought）
历史信息（history）
获取信息（retrieve）
点赞(like)
踩(dislike)
收藏(collect)
评论(comment)

历史信息

以下是一个时序查询历史信息的例子：
HTTP方法: PUT
URI: /

{
  "type":"publication",
  "subtype":"history",
  "id":"zxj2019",
  "password":"431fe828b9b8e8094235dee515562247",
  "from":"zxj2019",
  "time":"2019-11-04-04"
}

解释说明

{
  "type":"publication",                           固定使用publication，与系统其他类型相区分
  "subtype":"history",                            history表示时序查询
  "id":"zxj2019",                                 用户名
  "password":"431fe828b9b8e8094235dee515562247",  密码
  "from":"zxj2019",                               非必填项，查询zxj2019用户下发表的问题答案文章等，若不填则查询所有用户发表的内容
  "time":"2019-11-04-04"                          非必填项，查询2019年11月4日凌晨4点之前发表的内容，若不填则查询当前时间之前公开发表的内容
}

发送上述请求至social vertex服务器后，服务器返回样例：

{
  "publication":true,
  "history":[
    {"type":"publication","subtype":"question","description": "where is 小胖胖"}
  ],
  "time":"2019-11-04-04"
}

解释说明

{
  "publication":true,                             true表示查询成功，false则表示失败
  "history":[                                     history为查询到的publication json列表
    {"type":"publication","subtype":"question","description": "where is 小胖胖"}
  ],
  "time":"2019-11-04-04"                          time表示查询至该时间点，下次时序查询时填入该字符串，便可继续向前查询
}

获取信息

以下是一个获取公开信息的例子：
HTTP方法: PUT
URI: /

{
  "type":"publication",
  "subtype":"retrieve",
  "id":"zxj2019",
  "password":"431fe828b9b8e8094235dee515562247",
  "dir":"/2019/06/29/15/387a71fc-f440-47ab-9d4a-bdbc7cbff5dd"
}

解释说明

{
  "type":"publication",                                       固定使用publication，与系统其他类型相区分
  "subtype":"retrieve",                                       获取特定信息
  "dir":"/2019/06/29/15/387a71fc-f440-47ab-9d4a-bdbc7cbff5dd",特性信息所在路径
  "id":"zxj2019",                                             用户名
  "password":"431fe828b9b8e8094235dee515562247"               密码
}

发送上述请求至social vertex服务器后，服务器返回样例：

{
  "publication": true,
  "type": "publication",
  "subtype": "question"
}

解释说明

{
  "publication":true,                             true表示查询成功，false则表示失败
  "type": "publication"...                        其余字段为信息存入时信息
}

点赞

参数：

{
  "type":"publication",                                      
  "subtype":"like",                                          
  "dir":"/2019/06/29/15/387a71fc-f440-47ab-9d4a-bdbc7cbff5dd",特性信息所在路径
  "id":"zxj2019",                                             用户名
  "password":"431fe828b9b8e8094235dee515562247"               密码
}

返回样例：

{
  "publication":true,                             true表示点赞成功，false则表示失败
  "type": "publication"...                        其余字段为信息存入时信息
}

踩

同点赞（subtype 改为"subtype":"like"）

收藏

参数：

{
  "type":"publication",                                      
  "subtype":"collect",                                          
  "dir":"/2019/06/29/15/387a71fc-f440-47ab-9d4a-bdbc7cbff5dd",文章或评论的路径
  "id":"zxj2019",                                             用户名
  "password":"431fe828b9b8e8094235dee515562247"               密码
}

返回值样例：

{
  "publication":true,                             true表示收藏成功，false则表示失败
  "type": "publication"...                        其余字段为信息存入时信息
}

评论

对一个article/thought..... /comment 进行评论

参数：

{
  "type":"publication",                                      
  "subtype":"comment",                                          
  "dir":"/2019/06/29/15/387a71fc-f440-47ab-9d4a-bdbc7cbff5dd",文章或评论的路径
  "content":"str.....this is a comment for an article or a comment",评论内容
  "id":"zxj2019",                                             用户名
  "password":"431fe828b9b8e8094235dee515562247"               密码
}

返回值样例：

{
  "publication":true,                             true表示查询成功，false则表示失败
  "type": "publication"...                        其余字段为信息存入时信息
}

注：当对某一评论进行评论时 需要传commented_user_id属性

获取文章评论列表(包含coments of comment)：

参数：

{
  "type":"publication",                                      
  "subtype":"comment_list",                                          
  "dir":"/2019/06/29/15/387a71fc-f440-47ab-9d4a-bdbc7cbff5dd",文章或评论的路径
  "id":"zxj2019",                                             用户名
  "password":"431fe828b9b8e8094235dee515562247"               密码
}

返回值样例(注： commented_user_id 为被评论者的用户id ，id为评论者id):

{
  "publication":true,                             true表示查询成功，false则表示失败
  "type": "publication",
  "subtype":"comments_list",
  "info":{
  	"dir":"/2019/06/29/15/387a71fc-f440-47ab-9d4a-bdbc7cbff5dd",
  	"id":"zxj01",
  	"commented_user_id":"zxj01",
  	"comments":[
  	  {
  	  	"id":"zxj01",
  	  	"commented_user_id":"zxj01",
  	  	"dir":"/2019/06/29/15/387a71fc-f440-47ab-9d4a-bdbc7cbff5dd",
  	  	"date":"",
  	  	"time":"",
  			"content":" a comment",
  	  },
  		{
  			"dir":"/2019/06/29/15/387a71fc-f440-47ab-9d4a-bdbc7cbff5dd/sub1",
  			"content":"comment for this dir",
  			"id":"zxj01",
  			"commented_user_id":"zxj01",
  			"date":"",
  			"time":"",
  			"comments":[...]
  		},
  		{
  			"dir":"/2019/06/29/15/387a71fc-f440-47ab-9d4a-bdbc7cbff5dd/sub2",
  			"content":"comment for this dir",
  			"id":"zxj01",
  			"commented_user_id":"zxj01",
  			"date":"",
  			"time":"",
  			"comments":[...]
  		}
  	]
  }
}

注：comment实体结构如下：

{
  "dir":"/2019/06/29/15/387a71fc-f440-47ab-9d4a-bdbc7cbff5dd",
  "content":"",
  "id":"xxx", //评论者
  "commented_user_id":"xxx2", //被评论者
}

commented_user_id为该条被评论的用户id

评论的展示方式

  • 对于文章的评论，通过文章的dir属性访问comments接口,获取文章评论的列表。

  • 对于评论的评论，在上一步中 文章的评论实体中，也通过dir属性访问comments接口，此时返回的comments实体中存在commented_user_id属性，用来记录此条评论的回复对象。