Yoho-Documents / API-Interfaces · Commits

Go to a project

Authored by chaogeng
Commit ba0ac34a42b476a945e333845d4795f07379dfbc 2 parents b12bd2c2 875150ff

Merge branch 'master' of http://git.yoho.cn/yoho-documents/api-interfaces

Inline Side-by-side
Showing 1 changed file with 17 additions and 229 deletions
## 1、查询文章/晒单评论接口##
## 1、查询文章/晒单/潮物评论接口##
查询文章/晒单评论接口（app.grass.queryArticleComments)
查询文章/晒单/潮物评论接口（app.grass.queryArticleComments)
#### 请求参数
| 参数名称 | 参数类型 | 可否为空 | 示例 | 默认值 | 备注 |
|:-------| -----:|-----:|-----:|-----:|----:|
| destId | Integer | 否 | 1 | null | 文章/晒单id |
| destId | Integer | 否 | 1 | null | 文章/晒单/潮物id |
| uid | Integer | 否 | 1 | null | 用户uid |
| udid | String | 否 | "fdfs" | null | 用户udid |
| columnType | Integer | 否 | 1000 | null | 栏目类型（1000：文章，1001：晒单） |
| columnType | Integer | 否 | 1001 | null | 栏目类型（1001：文章；1002：晒单；1003：潮物） |
| limit | Integer | 是 | 10 | 10 | 每页总数 |
| page | Integer | 是 | 1 | 1 | 页号 |
... ... @@ -40,11 +40,10 @@ code为200即为成功。
"status": 1,
"uid": 600033622,
"columnType": 1000,
"shareOrderId": 600033622
"destId": 600033622
}
],
"parentComment": {
"articleId": 1,
"articleType": 1,
"content": "fsefs第三方",
"createTime": 23213,
... ... @@ -54,7 +53,7 @@ code为200即为成功。
"status": 0,
"uid": 500030381,
"columnType": 1000,
"shareOrderId": 600033622
"destId": 600033622
}
}
],
... ... @@ -70,9 +69,9 @@ code为200即为成功。
```
## 2、查询文章/晒单评论的回复接口##
## 2、查询文章/晒单/潮物评论的回复接口##
查询文章/晒单评论的回复接口（app.grass.queryArticleCommentReply)
查询文章/晒单/潮物评论的回复接口（app.grass.queryArticleCommentReply)
#### 请求参数
| 参数名称 | 参数类型 | 可否为空 | 示例 | 默认值 | 备注 |
|:-------| -----:|-----:|-----:|-----:|----:|
... ... @@ -111,8 +110,7 @@ code为200即为成功。
"status": 1,
"uid": 500030381,
"columnType": 1000,
"shareOrderId": 600033622
"destId": 600033622
}
],
"limit": 10,
... ... @@ -128,26 +126,25 @@ code为200即为成功。
## 3、新增文章评论（回复）接口##
## 3、新增文章/晒单/潮物评论（回复）接口##
新增文章评论（回复）接口（app.grass.addArticleComment)
新增文章/晒单/潮物评论（回复）接口（app.grass.addArticleComment)
#### 请求参数
| 参数名称 | 参数类型 | 可否为空 | 示例 | 默认值 | 备注 |
|:-------| -----:|-----:|-----:|-----:|----:|
| content | String | 否 | "fsdfsd" | null | 评论id |
| articleId | Integer | 是 | 1 | null | 文章id（addType=0并且columnType=1000时，需要该字段） |
| destId | Integer | 是 | 1 | null | 文章/晒单/潮物id（addType=0时，需要该字段） |
| uid | Integer | 否 | 1 | null | 用户uid |
| parentId | Integer | 是 | 10 | null | 父评论id(addType=0时，此参数不需要) |
| rootId | Integer | 是 | 1 | null | 跟评论id（addType=0时，此参数不需要） |
| addType | Integer | 否 | 1 | null | 类型（0：对文章评论；1：对评论进行评论） |
| columnType | Integer | 否 | 1000 | null | 栏目类型（1000：文章；1001：晒单） |
| shareOrderId | Integer | 是 | 1 | null | 晒单id（addType=0并且columnType=1001时，需要该字段） |
| commentId | Integer | 是 | 10 | null | 父评论id(addType=0时，此参数不需要) |
| rootId | Integer | 是 | 1 | null | 根评论id（addType=0时，此参数不需要） |
| addType | Integer | 否 | 1 | null | 类型（0：对内容评论；1：对评论进行评论） |
| columnType | Integer | 否 | 1001 | null | 栏目类型（1001：文章；1002：晒单；1003：潮物） |
注意，通用的头部没有列出。
请求示例
http://api-test3.dev.yohocorp.com/gateway?commentId=2&uid=500030381&content=testbac第三方搜索ssscsg的方式&parentId=66&rootId=66&addType=1&method=app.grass.addArticleComment
http://api-test3.dev.yohocorp.com/gateway?commentId=2&uid=500030381&content=testbac第三方搜索ssscsg的方式&destId=66&rootId=66&addType=1&method=app.grass.addArticleComment
### 响应
code为200即为成功。
... ... @@ -161,212 +158,3 @@ code为200即为成功。
"message": "success."
}
```
## 4、查询潮物评论接口##
查询潮物评论接口（app.grass.queryGoodsComments)
#### 请求参数
| 参数名称 | 参数类型 | 可否为空 | 示例 | 默认值 | 备注 |
|:-------| -----:|-----:|-----:|-----:|----:|
| goodsId | Integer | 否 | 1 | null | 潮物id |
| uid | Integer | 否 | 1 | null | 用户uid |
| udid | String | 否 | "fdfs" | null | 用户udid |
| limit | Integer | 是 | 10 | 10 | 每页总数 |
| page | Integer | 是 | 1 | 1 | 页号 |
注意，通用的头部没有列出。
请求示例
http://api-test3.dev.yohocorp.com/gateway?goodsId=6&uid=500030381&page=1&limit=100&udid=1&method=app.grass.queryGoodsComments
### 响应
code为200即为成功。
响应JSON格式如下所示:
```json
{
"alg": "SALT_MD5",
"code": 200,
"data": {
"commentInfos": [
{
"childrenComments": [],
"parentComment": {
"content": "春风十里七里香",
"createTime": 1547609749,
"goodsId": 6,
"id": 42,
"isPraise": "N",
"parentId": 40,
"praiseTotal": 0,
"status": 1,
"uid": 500030382
}
}
],
"limit": 100,
"page": 1,
"pageSize": 0,
"total": 38,
"totalPage": 1
},
"md5": "db7610962a5711c9922dfeb02ee49676",
"message": "操作成功"
}
```
## 5、查询潮物评论的回复接口##
查询潮物评论的回复接口（app.grass.queryGoodsCommentReply)
#### 请求参数
| 参数名称 | 参数类型 | 可否为空 | 示例 | 默认值 | 备注 |
|:-------| -----:|-----:|-----:|-----:|----:|
| commentId | Integer | 否 | 1 | null | 评论id |
| uid | Integer | 否 | 1 | null | 用户uid |
| udid | String | 否 | "fdfs" | null | 用户udid |
| limit | Integer | 是 | 10 | 10 | 每页总数 |
| page | Integer | 是 | 1 | 1 | 页号 |
注意，通用的头部没有列出。
请求示例
http://api-test3.dev.yohocorp.com/gateway?commentId=32&uid=500030381&udid=1&method=app.grass.queryGoodsCommentReply
### 响应
code为200即为成功。
响应JSON格式如下所示:
```json
{
"alg": "SALT_MD5",
"code": 200,
"data": {
"childrenComments": [
{
"content": "testbac第三方",
"createTime": 1548591444,
"headIco": "http://img11.static.yhbimg.com/yhb-img01/2016/07/05/13/017ec560b82c132ab2fdb22f7cf6f42b83.png?imageView2/0/w/100/h/100",
"id": 172,
"isPraise": "N",
"parentId": 32,
"parentUid": 500030381,
"parentUserName": "123_XPkALw",
"praiseTotal": 0,
"rootId": 32,
"status": 0,
"uid": 500030381,
"userName": "123_XPkALw"
}
],
"limit": 10,
"page": 1,
"pageSize": 0,
"total": 2,
"totalPage": 1
},
"md5": "c8edf697e395a6d5fbaee6f0b4c6fbf7",
"message": "操作成功"
}
```
## 6、新增潮物评论（回复）接口##
新增文章评论（回复）接口（app.grass.addArticleComment)
#### 请求参数
| 参数名称 | 参数类型 | 可否为空 | 示例 | 默认值 | 备注 |
|:-------| -----:|-----:|-----:|-----:|----:|
| content | String | 否 | "fsdfsd" | null | 评论id |
| goodsId | Integer | 是 | 1 | null | 潮物id（addType=1时，此参数不需要） |
| uid | Integer | 否 | 1 | null | 用户uid |
| parentId | Integer | 是 | 10 | null | 父评论id(addType=0时，此参数不需要) |
| rootId | Integer | 是 | 1 | null | 跟评论id（addType=0时，此参数不需要） |
| addType | Integer | 否 | 1 | null | 类型（0：对文章评论；1：对评论进行评论） |
注意，通用的头部没有列出。
请求示例
http://api-test3.dev.yohocorp.com/gateway?commentId=2&uid=500030381&content=testbac第三方&goodsId=1&parentId=32&rootId=32&addType=1&method=app.grass.addGoodsComment
### 响应
code为200即为成功。
响应JSON格式如下所示:
```json
{
"alg": "SALT_MD5",
"code": 200,
"data": [],
"md5": "6d729d4b35f10fc73531210bd7ecff91",
"message": "success."
}
```
## 7、文章点赞/取消接口##
文章点赞/取消接口（app.grass.updateArticlePraise)
#### 请求参数
| 参数名称 | 参数类型 | 可否为空 | 示例 | 默认值 | 备注 |
|:-------| -----:|-----:|-----:|-----:|----:|
| udid | String | 否 | "fsdfsd" | null | 用户udid |
| articleId | Integer | 否 | 1 | null | 文章id |
| isAdd | String | 否 | "Y" | null | 是否点赞(Y：点赞，N：取消) |
注意，通用的头部没有列出。
请求示例
http://api-test3.dev.yohocorp.com/gateway?articleId=30&udid=地方32发ff&isAdd=N&method=app.grass.updateArticlePraise
### 响应
code为200即为成功。
响应JSON格式如下所示:
```json
{
"alg": "SALT_MD5",
"code": 200,
"data": [],
"md5": "6d729d4b35f10fc73531210bd7ecff91",
"message": "success."
}
```
## 8、（潮物/文章）评论点赞/取消接口##
（潮物/文章）评论点赞/取消接口（app.grass.updateCommentPraise)
#### 请求参数
| 参数名称 | 参数类型 | 可否为空 | 示例 | 默认值 | 备注 |
|:-------| -----:|-----:|-----:|-----:|----:|
| udid | String | 否 | "fsdfsd" | null | 用户udid |
| commentId | Integer | 否 | 1 | null | 评论id |
| isAdd | String | 否 | "Y" | null | 是否点赞(Y：点赞，N：取消) |
| type | Integer | 否 | "Y" | null | 类型(0：文章，1：潮物) |
注意，通用的头部没有列出。
请求示例
http://api-test3.dev.yohocorp.com/gateway?commentId=32&udid=3&isAdd=Y&type=1&method=app.grass.updateCommentPraise
### 响应
code为200即为成功。
响应JSON格式如下所示:
```json
{
"alg": "SALT_MD5",
"code": 200,
"data": [],
"md5": "6d729d4b35f10fc73531210bd7ecff91",
"message": "success."
}
```
\ No newline at end of file
... ...