Toggle navigation
Toggle navigation
This project
Loading...
Sign in
michaelcao
/
yohobuy-doc
·
Commits
Go to a project
GitLab
Go to dashboard
Project
Activity
Files
Commits
Pipelines
0
Builds
0
Graphs
Milestones
Issues
0
Merge Requests
0
Members
Labels
Wiki
Forks
Network
Create a new issue
Download as
Email Patches
Plain Diff
Browse Files
Authored by
lijian
9 years ago
Commit
2b06dadde53dd37aaaf336bab4644443f2553941
1 parent
70f12114
搜索词管理
Hide whitespace changes
Inline
Side-by-side
Showing
1 changed file
with
369 additions
and
0 deletions
inferface-document/search_words.md
inferface-document/search_words.md
View file @
2b06dad
...
...
@@ -394,6 +394,375 @@
}
```
## 新增热搜索词
> 接口名:`searchWords/addSearchWords`
### 入参
-------------------------
|属性名称|类型|例子|说明|
|--------|----|----|----|
|type|int|3|搜索词类型:3 热搜索词 |
|content|String|内容实得分|内容|
|sort|int|3|排序 |
|channelIds|String|1,2,3|频道类型 多个用逗号隔开 默认搜索词专用|
|url|String|https://pandao.github.io/editor.md/examples/simple.html|链接|
|creatorUid|int|2323|添加人id|
|creatorUsrname|String|zhangsan|添加人名称|
---------------------
### 返回
```
json
请求样例:
{
"channelIds"
:
"2,3"
,
"content"
:
"2342"
,
"creatorUid"
:
3
,
"creatorUsrname"
:
"zhangsan"
,
"modifyUid"
:
3
,
"modifyUsrname"
:
"zhangsan"
,
"type"
:
3
,
"url"
:
"https://pandao.github.io/editor.md/examples/simple.html"
}
正常返回:
{
"code"
:
200
,
"data"
:
[],
"md5"
:
"d751713988987e9331980363e24189ce"
,
"message"
:
"添加成功"
}
异常返回:
{
"code"
:
405
,
"data"
:
[],
"md5"
:
"d751713988987e9331980363e24189ce"
,
"message"
:
"频道不能为空"
}
```
## 修改热搜索词
> 接口名:`searchWords/updateSearchWords`
### 入参
-------------------------
|属性名称|类型|例子|说明|
|--------|----|----|----|
|id|int|1|主键 |
|type|int|3|搜索词类型:3 热搜索词 |
|sort|int|3|排序 |
|content|String|内容实得分|内容|
|channelIds|String|1,2,3|频道类型 多个用逗号隔开 默认搜索词专用|
|url|String|https://pandao.github.io/editor.md/examples/simple.html|链接|
|status|int|1|状态 2 开启 1 禁用|
|modifyUid|int|2323|修改人id|
|modifyUsrname|String|zhangsan|修改人名称|
---------------------
### 样例
```
json
请求样例:
{
"channelIds"
:
"2,3"
,
"content"
:
"2342"
,
"modifyUid"
:
3
,
"modifyUsrname"
:
"zhangsan"
,
"type"
:
3
,
"sort"
:
23
,
"status"
:
1
,
"id"
:
111
,
"url"
:
"https://pandao.github.io/editor.md/examples/simple.html"
}
正常返回:
{
"code"
:
200
,
"data"
:
[],
"md5"
:
"d751713988987e9331980363e24189ce"
,
"message"
:
"修改成功"
}
异常返回:
{
"code"
:
405
,
"data"
:
[],
"md5"
:
"d751713988987e9331980363e24189ce"
,
"message"
:
"内容不能为空"
}
```
## 查询热搜索词
> 接口名: `/searchWords/querySearchWords`
### 入参
-------------------------
|属性名称|类型|例子|说明|
|--------|----|----|----|
|page|int|2|第几页|
|size|int|50|每页条数|
|type|int|3|搜索词类型:3 搜索词 必填|
|channelIds|String|3|频道类型|
|content|String|内容实得分|内容|
|status|int|1|状态 2 开启 1 禁用|
---------------------------
### 返回
```
json
请求
{
"page"
:
1
,
"size"
:
3
,
"content"
:
"哈哈"
,
"type"
:
3
,
"channelIds"
:
1
}
返回:
同默认搜索词
```
## 新增同义词
> 接口名:`searchWords/addSearchWords`
### 入参
-------------------------
|属性名称|类型|例子|说明|
|--------|----|----|----|
|type|int|4|搜索词类型:4 同义词 |
|content|String|内容巴拉|内容|
|creatorUid|int|2323|添加人id|
|creatorUsrname|String|zhangsan|添加人名称|
---------------------
### 返回
```
json
请求样例:
{
"content"
:
"2342"
,
"creatorUid"
:
3
,
"creatorUsrname"
:
"zhangsan"
,
"type"
:
3
}
正常返回:
{
"code"
:
200
,
"data"
:
[],
"md5"
:
"d751713988987e9331980363e24189ce"
,
"message"
:
"添加成功"
}
异常返回:
{
"code"
:
405
,
"data"
:
[],
"md5"
:
"d751713988987e9331980363e24189ce"
,
"message"
:
"频道不能为空"
}
```
## 修改同义词
> 接口名:`searchWords/updateSearchWords`
### 入参
-------------------------
|属性名称|类型|例子|说明|
|--------|----|----|----|
|id|int|1|主键 |
|type|int|4|搜索词类型:4 同义词 |
|content|String|内容巴拉|内容|
|status|int|1|状态 2 开启 1 禁用|
|modifyUid|int|2323|修改人id|
|modifyUsrname|String|zhangsan|修改人名称|
---------------------
### 样例
```
json
请求样例:
{
"content"
:
"2342"
,
"modifyUid"
:
3
,
"modifyUsrname"
:
"zhangsan"
,
"type"
:
4
,
"status"
:
1
,
"id"
:
111
}
正常返回:
{
"code"
:
200
,
"data"
:
[],
"md5"
:
"d751713988987e9331980363e24189ce"
,
"message"
:
"修改成功"
}
异常返回:
{
"code"
:
405
,
"data"
:
[],
"md5"
:
"d751713988987e9331980363e24189ce"
,
"message"
:
"内容不能为空"
}
```
## 查询同义词
> 接口名: `/searchWords/querySearchWords`
### 入参
-------------------------
|属性名称|类型|例子|说明|
|--------|----|----|----|
|page|int|2|第几页|
|size|int|50|每页条数|
|type|int|4|搜索词类型:4 同义词 |
|content|String|内容巴拉|内容|
|status|int|1|状态 2 开启 1 禁用|
---------------------------
### 返回
```
json
请求
{
"page"
:
1
,
"size"
:
3
,
"content"
:
"哈哈"
,
"type"
:
3
}
返回:
同默认搜索词
```
## 新增停用词
> 接口名:`searchWords/addSearchWords`
### 入参
-------------------------
|属性名称|类型|例子|说明|
|--------|----|----|----|
|type|int|5|搜索词类型:5 停用词 |
|content|String|内容巴拉|内容|
|creatorUid|int|2323|添加人id|
|creatorUsrname|String|zhangsan|添加人名称|
---------------------
### 返回
```
json
请求样例:
{
"content"
:
"2342"
,
"creatorUid"
:
3
,
"creatorUsrname"
:
"zhangsan"
,
"type"
:
3
}
正常返回:
{
"code"
:
200
,
"data"
:
[],
"md5"
:
"d751713988987e9331980363e24189ce"
,
"message"
:
"添加成功"
}
异常返回:
{
"code"
:
405
,
"data"
:
[],
"md5"
:
"d751713988987e9331980363e24189ce"
,
"message"
:
"频道不能为空"
}
```
## 修改停用词
> 接口名:`searchWords/updateSearchWords`
### 入参
-------------------------
|属性名称|类型|例子|说明|
|--------|----|----|----|
|id|int|1|主键 |
|type|int|5|搜索词类型:5 停用词 |
|content|String|内容巴拉|内容|
|status|int|1|状态 2 开启 1 禁用|
|modifyUid|int|2323|修改人id|
|modifyUsrname|String|zhangsan|修改人名称|
---------------------
### 样例
```
json
请求样例:
{
"content"
:
"2342"
,
"modifyUid"
:
3
,
"modifyUsrname"
:
"zhangsan"
,
"type"
:
4
,
"status"
:
1
,
"id"
:
111
}
正常返回:
{
"code"
:
200
,
"data"
:
[],
"md5"
:
"d751713988987e9331980363e24189ce"
,
"message"
:
"修改成功"
}
异常返回:
{
"code"
:
405
,
"data"
:
[],
"md5"
:
"d751713988987e9331980363e24189ce"
,
"message"
:
"内容不能为空"
}
```
## 查询停用词
> 接口名: `/searchWords/querySearchWords`
### 入参
-------------------------
|属性名称|类型|例子|说明|
|--------|----|----|----|
|page|int|2|第几页|
|size|int|50|每页条数|
|type|int|5|搜索词类型:5 停用词 |
|content|String|内容巴拉|内容|
|status|int|1|状态 2 开启 1 禁用|
---------------------------
### 返回
```
json
请求
{
"page"
:
1
,
"size"
:
3
,
"content"
:
"哈哈"
,
"type"
:
3
}
返回:
同默认搜索词
```
...
...
Please
register
or
login
to post a comment