mirrors/isearch
1
0
Fork 0
Code Issues Pull Requests Actions Packages Projects Releases Wiki Activity

modify API doc

Browse Source
This commit is contained in:
shzhulin3 2021-04-07 14:54:50 +08:00
parent a1b4474015
commit cb4ac23e0e
1 changed files with 12 additions and 7 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

7
docs/API.md
View File

@ -25,8 +25,11 @@ JSON
| sort_type | int | 否 | 排序方式 | | sort_type | int | 否 | 排序方式 |
| sort_field | string | 否 | 排序字段 | | sort_field | string | 否 | 排序字段 |
| fields | string | 否 | 返回指定字段值 | | fields | string | 否 | 返回指定字段值 |
说明：key支持多字段检索，如key为”content:京东 author:张三”表示搜索content字段包含京东并且author是张三的记录，其中city为应用内配置的字段名，应用可以自定义字段名称。 说明：key支持多字段检索，如key为”content:京东 author:张三”表示搜索content字段包含京东并且author是张三的记录，其中city为应用内配置的字段名，应用可以自定义字段名称。
应用的定义及支持的字段类型可参考：[项目配置文件](https://gitee.com/jd-platform-opensource/isearch#%E9%A1%B9%E7%9B%AE%E9%85%8D%E7%BD%AE%E6%96%87%E4%BB%B6) 应用的定义及支持的字段类型可参考：[项目配置文件](https://gitee.com/jd-platform-opensource/isearch#%E9%A1%B9%E7%9B%AE%E9%85%8D%E7%BD%AE%E6%96%87%E4%BB%B6)
### Http返回结果说明 ### Http返回结果说明
| 字段 | 类型 | 描述 | | 字段 | 类型 | 描述 |
| ------------ | ------------ | ------------ | | ------------ | ------------ | ------------ |
@ -34,7 +37,7 @@ JSON
| count | int | 结果总数 | | count | int | 结果总数 |
| result | string | 结果内容 | | result | string | 结果内容 |
### CURL调用示例 ### CURL调用示例
```html ```
curl 'http://127.0.0.1/index/search?page_index=0&key=京东&appid=10001' curl 'http://127.0.0.1/index/search?page_index=0&key=京东&appid=10001'
``` ```
### 成功返回示例 ### 成功返回示例
@ -77,7 +80,9 @@ JSON
| ------------ | ------------ | ------------ | ------------ | | ------------ | ------------ | ------------ | ------------ |
| cmd | string | 是 | 操作类型 | | cmd | string | 是 | 操作类型 |
| fields | object | 是 | 文章对象 | | fields | object | 是 | 文章对象 |
注：cmd取值包括add,delete,update。 注：cmd取值包括add,delete,update。
#### fields的参数 #### fields的参数
| 参数 | 类型 | 是否必需 | 描述 | | 参数 | 类型 | 是否必需 | 描述 |
| ------------ | ------------ | ------------ | ------------ | | ------------ | ------------ | ------------ | ------------ |