种草搜索接口文档

张帅
Commit 2019c612f30d4377f95b4764c0430799c1ec257b 1 parent 620c97ad
Showing 1 changed file with 207 additions and 0 deletions
种草/搜索.md
--- a/种草/搜索.md 0 → 100644
View file @2019c61
+++ b/种草/搜索.md 0 → 100644
View file @2019c61
+## 1、搜索接口，模糊搜索 话题、内容、用户##
+
+搜索接口（method=app.grass.searchIndex)
+#### 请求参数
+| 参数名称 | 参数类型 |  可否为空 | 示例 | 默认值 | 备注 | 
+|:-------| -----:|-----:|-----:|-----:|----:| 
+| page | Integer | 是 | 1 | 1 | 页码 |
+| limit | Integer | 是 | 1 | 5 | 每页显示条数 |
+| uid | Integer | 是 | 380463 | 0 | 用户uid |
+| udid | String | 否 | "" | "" | 设备标识 |
+| keyword | String | 否 | "" | "" | 搜索关键词 |
+| searchType | Integer | 否 | 1 | 1 | 搜索类型：1 内容 2用户 |
+| tabType | Integer | 否 | 101 | 101 | 搜索内容时, tab栏的类型 101：最新  102:最热 |
+| needTopic | Integer | 否 | 1 | 1 | 是否需要查询话题(首次搜索内容时需要，在内容下切换tab栏不需要)： 1 需要 2 不需要 |
+| lastedTime | String | 是 | "1548905701041" | null | 第一次请求或者刷新列表时不传, 接口会返回此字段，后续分页请求带上该字段值 |
+
+注意，通用的头部没有列出。  
+请求示例
+http://api-test3.dev.yohocorp.com/?method=app.grass.searchIndex&uid=500031572&keyword=你哭&debug=XYZ&udid=861243048197754cd2de191342aa531&page=1&limit=5&searchType=1&tabType=1&needTopic=1
+
+### 响应
+code为200即为成功。 
+响应JSON格式如下所示:
+```json
+{
+  "alg": "SALT_MD5",
+  "code": 200,
+  "data": {
+    "articleList": [
+      {
+        "articleId": 140412,
+        "articleType": 1,
+        "authorHeadIco": "http://img11.static.yhbimg.com/yhb-img01/2016/07/05/13/017ec560b82c132ab2fdb22f7cf6f42b83.png?imageView/{mode}/w/{width}/h/{height}",
+        "authorName": "",
+        "authorType": 1,
+        "authorUid": 500031572,
+        "content": "你不知道    我最喜欢的事   就是看着你哭😇",
+        "coverImage": "http://img12.static.yhbimg.com/grassImg/2019/03/12/13/02296a9aca12659c53430cdf770bfee02b.jpg?imageView2/{mode}/w/{width}/h/{height}",
+        "dataType": 1,
+        "favoriteCount": 3,
+        "hasFavor": "N",
+        "hasPraised": "Y",
+        "imageHeight": "500",
+        "imageWidth": "500",
+        "isTop": 0,
+        "praiseCount": 53,
+        "publishTime": 1552370546786,
+        "publishTimeStr": "2019-03-12 14:02:26"
+      },
+      {
+        "articleId": 74810,
+        "articleType": 5,
+        "authorHeadIco": "http://img11.static.yhbimg.com/yhb-img01/2016/07/05/13/017ec560b82c132ab2fdb22f7cf6f42b83.png?imageView/{mode}/w/{width}/h/{height}",
+        "authorName": "",
+        "authorType": 1,
+        "authorUid": 53075716,
+        "content": "同手同脚\n“从来哭着闹着要走的人，都不是真正会离开的人。真正想要离开的那个人，挑一个风和日丽的下午，穿上一件大衣出门，消失在秋日的阳光里，再也没有回来。” \n世界上存在着这样一种人，你们在一起会经常打架，不停斗嘴，他会很坏地抢你的好吃的，你会向父母打他的小报告，他总是惹你哭，你就爱逗他生气，但是有一天你会发现他比你最亲密的爱人都要爱护你，这样一种关系就叫做，手足。\n在我未来生命之旅，要和你同手同脚的走下去。",
+        "coverImage": "http://imgboys1.yohobuy.com/cmsimg01/2018/02/22/11/18/0190b05d234fd6f54c92012c5d06dc5319.jpeg?imageView2/{mode}/w/{width}/h/{height}",
+        "dataType": 1,
+        "favoriteCount": 0,
+        "hasFavor": "N",
+        "hasPraised": "N",
+        "imageHeight": "1206",
+        "imageWidth": "933",
+        "isTop": 0,
+        "praiseCount": 7,
+        "publishTime": 1519269486335,
+        "publishTimeStr": "2018-02-22 11:18:06",
+        "relateId": 160699
+      }
+    ],
+    "pageNo": 1,
+    "pageSize": 5,
+    "topicList": [
+      {
+        "id": 2648,
+        "isHot": 0,
+        "topicImageUrl": "http://flv01.static.yhbimg.com/grassImg/2019/05/07/14/03f8fdbe8263cd26c8c8bb20e75c66239c.png",
+        "topicName": "你哭的样子好美"
+      }
+    ],
+    "totalCount": 2,
+    "totalPage": 0
+  },
+  "md5": "460702a5a46be5f7bfe0f80499279e11",
+  "message": "操作成功"
+}
+```
+
+请求示例:搜索用户
+http://api-test3.dev.yohocorp.com/?method=app.grass.searchIndex&uid=500031572&keyword=xianmu&debug=XYZ&udid=861243048197754cd2de191342aa531&page=1&limit=5&searchType=2&tabType=1&needTopic=2
+
+### 响应
+code为200即为成功。 
+响应JSON格式如下所示:
+```json
+{
+  "alg": "SALT_MD5",
+  "code": 200,
+  "data": {
+    "pageNo": 1,
+    "pageSize": 5,
+    "totalCount": 1,
+    "totalPage": 0,
+    "userList": [
+      {
+        "articleCount": 2143,
+        "fansCount": 49,
+        "hasAttention": "N",
+        "headIco": "http://head.static.yhbimg.com/yhb-head/2019/05/06/15/01b9f5d1a9dba5346bf62fe69e0d8f2aa5.jpg",
+        "nickName": "xianmu",
+        "userType": 1
+      }
+    ]
+  },
+  "md5": "493c35be7a98a9e240edf39b978ba5cc",
+  "message": "操作成功"
+}
+```
+
+## 2、用户搜索记录接口(用户搜索记录，用户最近搜索的关键词记录)##
+
+用户搜索记录接口（method=app.grass.searchHistory)
+#### 请求参数
+| 参数名称 | 参数类型 |  可否为空 | 示例 | 默认值 | 备注 | 
+|:-------| -----:|-----:|-----:|-----:|----:| 
+| udid | String | 否 | "" | "" | 设备标识 |
+
+
+注意，通用的头部没有列出。  
+请求示例
+http://api-test3.dev.yohocorp.com/?method=app.grass.searchHistory&debug=XYZ&udid=861243048197754cd2de191342aa531
+
+### 响应
+code为200即为成功。 
+响应JSON格式如下所示:
+```json
+{
+  "alg": "SALT_MD5",
+  "code": 200,
+  "data": {
+    "keywords": [
+      "你哭",
+      "xianmu"
+    ]
+  },
+  "md5": "03b31c2f30eddc85f9e06f9475e4c5d4",
+  "message": "操作成功"
+}
+```
+
+## 3、最热搜索关键词接口##
+
+最热搜索关键词接口（method=app.grass.hotWords)
+#### 请求参数
+| 参数名称 | 参数类型 |  可否为空 | 示例 | 默认值 | 备注 | 
+|:-------| -----:|-----:|-----:|-----:|----:| 
+
+
+
+注意，通用的头部没有列出。  
+请求示例
+http://api-test3.dev.yohocorp.com/?method=app.grass.hotWords&debug=XYZ&udid=861243048197754cd2de191342aa531
+### 响应
+code为200即为成功。 
+响应JSON格式如下所示:
+```json
+{
+  "alg": "SALT_MD5",
+  "code": 200,
+  "data": {
+    "keywords": [
+      "你哭",
+      "xianmu"
+    ]
+  },
+  "md5": "03b31c2f30eddc85f9e06f9475e4c5d4",
+  "message": "操作成功"
+}
+```
+
+## 4、清空用户搜索记录##
+
+method=app.grass.clearSearchHistory
+#### 请求参数
+| 参数名称 | 参数类型 |  可否为空 | 示例 | 默认值 | 备注 | 
+|:-------| -----:|-----:|-----:|-----:|----:| 
+| udid | String | 否 | "" | "" | 设备标识 |
+
+注意，通用的头部没有列出。  
+请求示例
+http://api-test3.dev.yohocorp.com/?method=app.grass.clearSearchHistory&debug=XYZ&udid=861243048197754cd2de191342aa531
+
+### 响应
+code为200即为成功。 
+响应JSON格式如下所示:
+```json
+{
+	alg: "SALT_MD5",
+	code: 200,
+	data: {
+	
+	},
+	md5: "c9b255cf05bc5081e71fe1b418c8ec53",
+	message: "操作成功"
+}
+```