📝 docs(api): 补充 search 接口 tab_type 过滤语义
This commit is contained in:
1 parent
8bc6f5c2ae
commit
822d3fe444
2 files changed
+3
-3
No files matched your search
@@ -145,7 +145,7 @@ go run ./cmd/fanqie
|
|||||||
|
|
||||||
| 接口 | 方法 | 说明 | 参数 |
|
| 接口 | 方法 | 说明 | 参数 |
|
||||||
| ------ | ------ | ------ | ------ |
|
| ------ | ------ | ------ | ------ |
|
||||||
| `/search` | GET | 搜索书籍 | `query`(或 `key`), `tab_type`, `offset` |
|
| `/search` | GET | 搜索书籍 | `query`(或 `key`), `tab_type`, `offset`(`search_tabs` 仅返回匹配 `tab_type` 的 tab) |
|
||||||
| `/detail` | GET | 书籍详情 | `book_id` |
|
| `/detail` | GET | 书籍详情 | `book_id` |
|
||||||
| `/info` | GET | 书籍详情(同 detail) | `book_id` |
|
| `/info` | GET | 书籍详情(同 detail) | `book_id` |
|
||||||
| `/catalog` | GET | 章节目录 | `book_id` |
|
| `/catalog` | GET | 章节目录 | `book_id` |
|
||||||
|
|||||||
+2
-2
@@ -171,12 +171,12 @@ paths:
|
|||||||
example: 0
|
example: 0
|
||||||
- name: tab_type
|
- name: tab_type
|
||||||
in: query
|
in: query
|
||||||
description: 搜索类型,默认 3
|
description: 搜索类型,默认 3;响应 search_tabs 仅保留匹配该值的 tab
|
||||||
schema: { type: integer, default: 3 }
|
schema: { type: integer, default: 3 }
|
||||||
example: 3
|
example: 3
|
||||||
responses:
|
responses:
|
||||||
"200":
|
"200":
|
||||||
description: 搜索结果(上游转发,结构以实际返回为准)
|
description: 搜索结果(search_tabs 已按请求的 tab_type 过滤,仅保留匹配项)
|
||||||
content:
|
content:
|
||||||
application/json:
|
application/json:
|
||||||
schema:
|
schema:
|
||||||
|
|||||||
Reference in new issue
Block a user