Blame view

搜索/yohomars-search接口说明.md 8.55 KB
wangnan authored
1 2 3 4 5 6 7 8 9
##yohomars-search  接口说明。

服务地址:
http://192.168.102.17:8087/yohomars-search

搜索接口:
http://192.168.102.17:8087/yohomars-search/search.json
联想接口:
http://192.168.102.17:8087/yohomars-search/suggest.json
wangnan authored
10 11
聚合接口:
http://192.168.102.17:8087/yohomars-search/aggregate.json
wangnan authored
12
wangnan authored
13
##查询
wangnan authored
14 15 16 17 18 19 20 21 22 23 24 25 26 27 28 29 30
指定索引参数(必传)
参数名: type
|类型|参数值|
|---|---|---|
|商圈 |bizarea|
|店铺 |store|
|线路 |line|
|主题| topic|
|评论 |comment|

###店铺:store
索引字段
|名称|存储类型|描述
|---|---|---|
|id|int|id|
|city_id|int|城市标识|
|bizId|int|商圈标识|
wangnan authored
31
|is_recommend|int|是否推荐|
wangnan authored
32 33 34 35 36 37 38 39 40 41 42 43 44 45 46 47
|recommend_time|int|推荐时间|
|order_by|int|排序|
|consumption|int|消费量|
|score|int|分数|
|assessment_num|int|评价数量|
|sort|int|分类|
|pin|string|地理位置坐标|
|latitude|int|纬度|
|longitude|int|精度|
|store_name|string|店铺名称|
|store_english_name|string|店铺名称英文|
|store_name_tc|string|店铺名称繁体|
|tags|string|标签|
|store_first|string|综合的查询字段|
|des|string|描述|
|suggest|string|用于搜索栏联想的字段|
wangnan authored
48
|isShield|int|是否屏蔽|
wangnan authored
49 50 51 52 53 54 55 56 57 58 59 60 61 62 63 64 65 66 67 68 69 70 71 72 73 74 75 76 77 78 79 80 81 82


####查询所有:
http://192.168.102.17:8087/yohomars-search/search.json?type=store

####查询:
```
格式:query=keyword
```
默认查询字段:索引中的string字段
指定查询字段:
```
格式  queryField=field1,field2
```
地理位置范围查询:
&longitude=-1&latitude=0.7&range_start=0&range_end=1000000

####过滤:
```
格式: fieldname=value
```
field:所有int类型字段


####返回字段:
默认:返回所有字段
返回指定字段:
```
格式 returnField=field1,field2
```

####返回数据结构
```
{
wangnan authored
83 84 85
  "code": 200, 
  "status": 0, 
  "time": 14, 
wangnan authored
86
  "matches": {
wangnan authored
87 88 89
    "total": 1620, 
    "page": 1, 
    "Total_page": 162, 
wangnan authored
90 91
    "data": [
      {
wangnan authored
92 93 94 95 96 97 98 99 100 101 102 103 104 105 106 107 108 109 110 111 112 113 114 115 116 117 118 119 120 121
        "store_first": "购物名所 購物名所  前门123 前門 Qianmen 杨梅竹斜街26号 楊梅竹斜街26號", 
        "isShield": 0, 
        "latitude": 0.6964247164294038, 
        "consumption": 200, 
        "assessment_num": 0, 
        "sort": 99999, 
        "suggest": "Triple-Major 藥1739", 
        "store_name_tc": "藥", 
        "tags": 14, 
        "score": 5, 
        "store_english_name": "Triple-Major", 
        "des": "搬离了宝钞胡同,Triple-Major于北京的《藥》店在2015年初走进了这一年来声名大噪的杨梅竹斜街。别因其店名为《藥》就误以为它是药店,事实上它是不少时装精出没的买手店。顾名思义,中药是贯穿整个《藥》店的主线,除了装修、视觉元素围绕传统中药铺来出发外,甚至连这里的8个空间分割都跟中药有关。“本草”是用于举办各种互动活动,例如之前有个设计师就在这儿开了个“花果茶小卖部”,你可以利用3台扭蛋机来取出3种不同的花、果、茶材料来泡杯茶。而空间“五味”中的吊柜则从中药的甘、酸、苦、咸和辛这五味来分区,里面分别置有不同的衣服和配件供你选择。“四气”则是用于举办展览的区域,你会在这里看到定期更换的展览……所谓百闻不如一见,剩余的空间就交给你发掘了,mars就不一一跟你啰嗦了。 搬離了寶鈔胡同,Triple-Major于北京的《藥》店在2015年初走進了這一年來聲名大噪的楊梅竹斜街。别因其店名為《藥》就誤以為它是藥店,事實上它是不少時裝精出沒的買手店。顧名思義,中藥是貫穿整個《藥》店的主線,除了裝修、視覺元素圍繞傳統中藥鋪來出發外,甚至連這裡的8個空間分割都跟中藥有關。“本草”是用于舉辦各種互動活動,例如之前有個設計師就在這兒開了個“花果茶小賣部”,你可以利用3台扭蛋機來取出3種不同的花、果、茶材料來泡杯茶。而空間“五味”中的吊櫃則從中藥的甘、酸、苦、鹹和辛這五味來分區,裡面分别置有不同的衣服和配件供你選擇。“四氣”則是用于舉辦展覽的區域,你會在這裡看到定期更換的展覽……所謂百聞不如一見,剩余的空間就交給你發掘了,mars就不一一跟你啰嗦了。 时装 時裝,潮流 潮流,时尚 時尚", 
        "pin": {
          "location": [
            2.0315554651529357, 
            0.6964247164294038
          ]
        }, 
        "is_recommend": 0, 
        "bizId": 1, 
        "store_name": "藥1739", 
        "order_by": 999999, 
        "id": 2, 
        "city_id": 2, 
        "longitude": 2.0315554651529357
      }, 
      {
        "store_first": "书店 書店  前门123 前門 Qianmen 杨梅竹斜街23号 楊梅竹斜街23號", 
        "isShield": 0, 
        "latitude": 0.6964306156422756, 
wangnan authored
122 123 124
```

wangnan authored
125
##联想:
wangnan authored
126 127 128 129 130 131
http://192.168.102.17:8087/yohomars-search/suggest.json?type=bizarea&query=联想词


####返回数据结构
```
{
wangnan authored
132 133 134
  "code": 200, 
  "status": 0, 
  "time": 8, 
wangnan authored
135
  "matches": {
wangnan authored
136 137 138
    "total": 5, 
    "page": 1, 
    "Total_page": 1, 
wangnan authored
139 140
    "data": [
      {
wangnan authored
141 142 143 144 145 146 147 148 149 150 151 152 153
        "suggest": " 洋房火锅"
      }, 
      {
        "suggest": " 辉哥火锅 巨鹿路店"
      }, 
      {
        "suggest": " 花开藤蔓火锅"
      }, 
      {
        "suggest": "Mr. Meat 肉大人肉铺火锅"
      }, 
      {
        "suggest": " 夫妻肺片之味位火锅"
wangnan authored
154 155 156 157 158 159 160 161 162 163 164 165 166 167 168 169 170 171 172 173 174 175 176 177 178 179 180 181 182 183 184 185 186 187 188 189 190 191 192 193 194 195 196 197 198 199 200 201 202 203 204 205 206 207 208 209 210 211 212 213
      }
    ]
  }
}
```

###商圈

索引字段
|名称|存储类型|描述
|---|---|---|
|id|int|id|
|name|string|名称|
|english_name|string|英文名称|
|name_tc|string|繁体名称|
|des|string|描述|
|city_id|int|城市标志|
|store_num|int|店铺数量|
|is_top|int|是否置顶|
|top_time|int|置顶时间|
|is_recommend|int|推荐|
|sort|int|分类|
|recommend_time|int|推荐时间|
|suggest|string|联想字段|

####查询所有:
http://192.168.102.17:8087/yohomars-search/search.json?type=bizarea

其他同店铺

###线路

索引字段
|名称|存储类型|描述
|---|---|---|
|id|int|id|
|title|string|线路名称|
|title_tc|string|线路繁体名称|
|is_top|int|是否置顶|
|top_time|int|置顶时间|
|city_id|int|城市标志|
|publish_time|int|发布时间|
|city_id|int|城市标示|
|description|string|描述|
|description_tc|string|描述繁体|
|is_recommend|int|推荐|
|recommend_time|int|推荐时间|
|sort|int|分类|
|suggest|string|联想字段|

####查询所有:
http://192.168.102.17:8087/yohomars-search/search.json?type=line
其他同店铺

###主题

索引字段
|名称|存储类型|描述
|---|---|---|
|id|int|id|
wangnan authored
214 215
|title|string|线路名称|
|title_tc|string|线路繁体名称|
wangnan authored
216 217 218 219 220 221 222 223 224 225 226 227 228 229 230 231 232 233 234 235 236 237 238 239 240 241 242 243 244 245 246 247 248 249 250 251 252 253 254 255
|is_top|int|是否置顶|
|top_time|int|置顶时间|
|city_id|int|城市标志|
|publish_time|int|发布时间|
|city_id|int|城市标示|
|description|string|描述|
|description_tc|string|描述繁体|
|is_recommend|int|推荐|
|recommend_time|int|推荐时间|
|sort|int|分类|
|suggest|string|联想字段|

####查询所有:
http://192.168.102.17:8087/yohomars-search/search.json?type=topic
其他同店铺


###评论

索引字段
|名称|存储类型|描述
|---|---|---|
|id|int|id|
|uid|int|用户标识|
|description|string|描述|
|user_auth|int|user_auth|
|city_id|int|城市标示|
|user_type|int|用户类型|
|store_id|int|店铺标识|
|bizId|int|商圈标识|
|publish_time|int|发布时间|
|is_top|int|置顶|
|top_time|int|置顶时间|
|is_deleted|int|删除|

####查询所有:
http://192.168.102.17:8087/yohomars-search/search.json?type=comment
其他同店铺

wangnan authored
256 257 258 259 260 261 262 263 264 265 266 267 268 269 270 271 272 273 274 275 276 277 278 279 280 281 282 283 284 285 286 287 288 289 290 291 292 293 294 295 296 297 298 299 300 301 302 303 304 305 306 307 308 309 310
##直接更新索引数据
接口地址:
http://192.168.102.17:8087/yohomars-search/updateIndex.json?

参数:
|参数名|描述|值举例
|---|---|---|
|indexName  | 索引名 | bizarea,store,line,topic,comment
|action           |操作  |update,delete
|id               | 数据id| id
|data            |更新的数据|field1:value1,field2:value2

data格式
```
field1:value1,field2:value2
```

示例:
更新:
http://192.168.102.17:8087/yohomars-search/updateIndex.json?indexName=bizarea&action=update&id=1&data=name:%E5%89%8D%E9%97%A8Test,english_name:QianmenTest
删除:
http://192.168.102.17:8087/yohomars-search/updateIndex.json?indexName=bizarea&action=delete&id=1

###排序
```
格式: order=param1:param2,param1:param2
```
param1:  所有int类型字段:
param2:asc:增序 desc:降序

####距离排序规则
```
distance_order = param
```
param:asc:增序 desc:降序

####随机排序
```
order = random
```


##聚合
场景1:查询指定城市的商圈id
url示例:
http://192.168.102.17:8087/yohomars-search/aggregate?scene=aggBizAreaByCity&city_id=2
场景2:查询用户评价过的店铺id
url示例:
http://192.168.102.17:8087/yohomars-search/aggregate?scene=aggStoreByUser&uid=18108594





wangnan authored
311 312 313 314 315 316 317 318 319