From 7248ee6f2b83b6ed66d5f6289564474a09ba7e90 Mon Sep 17 00:00:00 2001 From: jlj <3042504846@qq.com> Date: Wed, 28 May 2025 11:40:38 +0800 Subject: [PATCH] =?UTF-8?q?=E5=88=A0=E9=99=A4=E6=B2=A1=E7=94=A8=E6=96=87?= =?UTF-8?q?=E4=BB=B6?= MIME-Version: 1.0 Content-Type: text/plain; charset=UTF-8 Content-Transfer-Encoding: 8bit --- search_api_documentation.md | 214 ------------------------------------ test_search_api.py | 174 ----------------------------- 2 files changed, 388 deletions(-) delete mode 100644 search_api_documentation.md delete mode 100644 test_search_api.py diff --git a/search_api_documentation.md b/search_api_documentation.md deleted file mode 100644 index aff6aac..0000000 --- a/search_api_documentation.md +++ /dev/null @@ -1,214 +0,0 @@ -# TikTok创作者数据库搜索API文档 - -## 概述 - -基于您的TikTok创作者数据库界面，我们实现了三个强大的搜索API，支持关键词搜索、高级筛选和搜索建议功能。 - -## API接口列表 - -### 1. 基础搜索API - -**接口地址：** `GET /creators/search/` - -**功能描述：** 基于关键词搜索创作者，支持搜索创作者名称、分类、MCN、曝光等级等字段 - -**请求参数：** -- `q` (string, 可选): 搜索关键词 -- `page` (int, 可选): 页码，默认为1 -- `page_size` (int, 可选): 每页数量，默认为10 - -**请求示例：** -``` -GET /creators/search/?q=beauty&page=1&page_size=10 -``` - -**响应示例：** -```json -{ - "code": 200, - "message": "搜索成功", - "data": { - "creators": [ - { - "Creator": { - "name": "Beauty Guru", - "avatar": "https://example.com/avatar.jpg" - }, - "Category": "Beauty & Personal Care", - "E-commerce Level": "L3", - "Exposure Level": "KOL-2", - "Followers": "162k", - "GMV": "$534k", - "Items Sold": "18k", - "Avg. Video Views": "1.9k", - "Pricing": "$80", - "Pricing Package": "Standard Package", - "# Collab": 15, - "Latest Collab.": "2024-01-15", - "E-commerce": ["TikTok Shop", "Instagram"], - "creator_id": 123, - "profile": "tiktok" - } - ], - "pagination": { - "current_page": 1, - "total_pages": 5, - "total_count": 50, - "has_next": true, - "has_prev": false, - "page_size": 10 - }, - "search_info": { - "query": "beauty", - "results_count": 50, - "search_applied": true - } - } -} -``` - -### 2. 高级搜索API - -**接口地址：** `POST /creators/search/advanced/` - -**功能描述：** 支持关键词搜索 + 多维度筛选条件的组合搜索 - -**请求参数：** -- URL参数： - - `page` (int, 可选): 页码，默认为1 - - `page_size` (int, 可选): 每页数量，默认为10 - -- POST请求体： -```json -{ - "q": "beauty", // 搜索关键词 - "filters": { - "category": ["Beauty & Personal Care", "Fashion"], // 分类多选 - "e_commerce_level": ["L2", "L3", "L4"], // 电商等级多选 - "exposure_level": ["KOL-1", "KOL-2"], // 曝光等级多选 - "gmv_range": ["$5k-$25k", "$25k-$50k"], // GMV范围多选 - "views_range": ["1000,10000"], // 观看量范围（新格式：最小值,最大值） - "followers_range": "10000,50000" // 粉丝数范围（格式：最小值,最大值） - } -} -``` - -**请求示例：** -```bash -curl -X POST "/creators/search/advanced/?page=1&page_size=10" \ - -H "Content-Type: application/json" \ - -H "Authorization: Token your_token_here" \ - -d '{ - "q": "beauty", - "filters": { - "category": ["Beauty & Personal Care"], - "e_commerce_level": ["L2", "L3"], - "gmv_range": ["$5k-$25k"] - } - }' -``` - -**响应格式：** 与基础搜索API相同，但增加了`filters_applied`字段 - -### 3. 搜索建议API - -**接口地址：** `GET /creators/search/suggestions/` - -**功能描述：** 提供搜索关键词的自动补全建议 - -**请求参数：** -- `q` (string, 必需): 搜索关键词（至少2个字符） -- `limit` (int, 可选): 建议数量限制，默认为10 - -**请求示例：** -``` -GET /creators/search/suggestions/?q=bea&limit=5 -``` - -**响应示例：** -```json -{ - "code": 200, - "message": "获取搜索建议成功", - "data": { - "query": "bea", - "suggestions": [ - { - "text": "Beauty Guru", - "type": "creator_name", - "label": "创作者: Beauty Guru" - }, - { - "text": "Beauty & Personal Care", - "type": "category", - "label": "分类: Beauty & Personal Care" - } - ], - "count": 2 - } -} -``` - -## 搜索功能特性 - -### 1. 智能搜索 -- **多字段搜索：** 同时搜索创作者名称、分类、MCN、曝光等级、电商平台 -- **模糊匹配：** 支持部分关键词匹配 -- **相关性排序：** 优先显示完全匹配和前缀匹配的结果 - -### 2. 高级筛选 -- **分类筛选：** 支持多选分类过滤 -- **电商等级：** L1-L7等级筛选 -- **曝光等级：** KOL-1, KOL-2, KOC-1等筛选 -- **GMV范围：** 多个价格区间选择 -- **观看量范围：** 自定义数值范围 -- **粉丝数范围：** 自定义粉丝数区间 - -### 3. 搜索建议 -- **实时建议：** 输入2个字符即可获得建议 -- **分类建议：** 区分创作者名称和分类建议 -- **去重处理：** 自动去除重复建议 - -## 数据格式说明 - -### 筛选条件格式 - -1. **观看量范围 (views_range)：** - - 新格式：`["1000,10000"]` （最小值,最大值） - - 兼容旧格式：`["1k-10k"]` - -2. **粉丝数范围 (followers_range)：** - - 格式：`"10000,50000"` （最小值,最大值） - -3. **GMV范围 (gmv_range)：** - - 预定义选项：`["$0-$5k", "$5k-$25k", "$25k-$50k", "$50k-$150k", "$150k-$400k", "$400k-$1500k", "$1500k+"]` - -### 响应数据格式 - -所有搜索API返回的创作者数据格式与您现有的筛选API保持一致，确保前端兼容性。 - -## 使用建议 - -1. **基础搜索：** 适用于简单的关键词搜索场景 -2. **高级搜索：** 适用于需要复杂筛选条件的场景 -3. **搜索建议：** 配合搜索框实现自动补全功能 - -## 错误处理 - -所有API都包含统一的错误处理机制： - -```json -{ - "code": 500, - "message": "搜索创作者失败: 具体错误信息", - "data": null -} -``` - -## 认证要求 - -所有搜索API都需要使用`CustomTokenAuthentication`进行身份验证： - -``` -Authorization: Token your_token_here -``` \ No newline at end of file diff --git a/test_search_api.py b/test_search_api.py deleted file mode 100644 index 7da9550..0000000 --- a/test_search_api.py +++ /dev/null @@ -1,174 +0,0 @@ -#!/usr/bin/env python3 -""" -TikTok创作者数据库搜索API测试脚本 -""" - -import requests -import json - -# 配置 -BASE_URL = "http://localhost:8000" # 根据您的服务器地址调整 -TOKEN = "your_token_here" # 替换为实际的认证token - -# 请求头 -HEADERS = { - "Authorization": f"Token {TOKEN}", - "Content-Type": "application/json" -} - -def test_basic_search(): - """测试基础搜索功能""" - print("=== 测试基础搜索功能 ===") - - # 测试1: 无关键词搜索（获取所有创作者） - print("\n1. 测试无关键词搜索:") - response = requests.get( - f"{BASE_URL}/creators/search/", - headers=HEADERS, - params={"page": 1, "page_size": 5} - ) - print(f"状态码: {response.status_code}") - if response.status_code == 200: - data = response.json() - print(f"总数量: {data['data']['pagination']['total_count']}") - print(f"返回数量: {len(data['data']['creators'])}") - else: - print(f"错误: {response.text}") - - # 测试2: 关键词搜索 - print("\n2. 测试关键词搜索 (搜索'beauty'):") - response = requests.get( - f"{BASE_URL}/creators/search/", - headers=HEADERS, - params={"q": "beauty", "page": 1, "page_size": 5} - ) - print(f"状态码: {response.status_code}") - if response.status_code == 200: - data = response.json() - print(f"搜索结果数量: {data['data']['search_info']['results_count']}") - print(f"搜索关键词: {data['data']['search_info']['query']}") - if data['data']['creators']: - print(f"第一个结果: {data['data']['creators'][0]['Creator']['name']}") - else: - print(f"错误: {response.text}") - -def test_advanced_search(): - """测试高级搜索功能""" - print("\n=== 测试高级搜索功能 ===") - - # 测试高级搜索 - search_data = { - "q": "beauty", - "filters": { - "category": ["Beauty & Personal Care", "Fashion"], - "e_commerce_level": ["L2", "L3"], - "gmv_range": ["$5k-$25k", "$25k-$50k"] - } - } - - print(f"\n搜索条件: {json.dumps(search_data, indent=2, ensure_ascii=False)}") - - response = requests.post( - f"{BASE_URL}/creators/search/advanced/", - headers=HEADERS, - params={"page": 1, "page_size": 5}, - json=search_data - ) - - print(f"状态码: {response.status_code}") - if response.status_code == 200: - data = response.json() - print(f"搜索结果数量: {data['data']['search_info']['results_count']}") - print(f"应用的筛选条件: {data['data']['search_info']['filters_applied']}") - if data['data']['creators']: - creator = data['data']['creators'][0] - print(f"第一个结果:") - print(f" - 名称: {creator['Creator']['name']}") - print(f" - 分类: {creator['Category']}") - print(f" - 电商等级: {creator['E-commerce Level']}") - print(f" - GMV: {creator['GMV']}") - else: - print(f"错误: {response.text}") - -def test_search_suggestions(): - """测试搜索建议功能""" - print("\n=== 测试搜索建议功能 ===") - - # 测试搜索建议 - test_queries = ["bea", "spo", "fas"] - - for query in test_queries: - print(f"\n搜索建议 '{query}':") - response = requests.get( - f"{BASE_URL}/creators/search/suggestions/", - headers=HEADERS, - params={"q": query, "limit": 5} - ) - - print(f"状态码: {response.status_code}") - if response.status_code == 200: - data = response.json() - suggestions = data['data']['suggestions'] - print(f"建议数量: {len(suggestions)}") - for suggestion in suggestions: - print(f" - {suggestion['label']}") - else: - print(f"错误: {response.text}") - -def test_pagination(): - """测试分页功能""" - print("\n=== 测试分页功能 ===") - - # 测试分页 - response = requests.get( - f"{BASE_URL}/creators/search/", - headers=HEADERS, - params={"page": 1, "page_size": 3} - ) - - print(f"状态码: {response.status_code}") - if response.status_code == 200: - data = response.json() - pagination = data['data']['pagination'] - print(f"分页信息:") - print(f" - 当前页: {pagination['current_page']}") - print(f" - 总页数: {pagination['total_pages']}") - print(f" - 总数量: {pagination['total_count']}") - print(f" - 有下一页: {pagination['has_next']}") - print(f" - 有上一页: {pagination['has_prev']}") - print(f" - 每页数量: {pagination['page_size']}") - else: - print(f"错误: {response.text}") - -def main(): - """主测试函数""" - print("TikTok创作者数据库搜索API测试") - print("=" * 50) - - try: - # 运行所有测试 - test_basic_search() - test_advanced_search() - test_search_suggestions() - test_pagination() - - print("\n" + "=" * 50) - print("所有测试完成！") - - except requests.exceptions.ConnectionError: - print("错误: 无法连接到服务器，请确保服务器正在运行") - except Exception as e: - print(f"测试过程中发生错误: {e}") - -if __name__ == "__main__": - print("请在运行测试前确保:") - print("1. 服务器正在运行") - print("2. 已更新BASE_URL和TOKEN配置") - print("3. 数据库中有测试数据") - print() - - confirm = input("是否继续运行测试? (y/n): ") - if confirm.lower() == 'y': - main() - else: - print("测试已取消") \ No newline at end of file