article
README
🚀 小红书 API 微服务
这是一个将小红书 API 封装成 RESTful API 服务器的微服务,支持使用 Docker 进行部署,能让开发者更便捷地操作小红书相关功能。
🚀 快速开始
前提条件
- Docker
- Docker Compose
安装和运行
- 构建并启动 Docker 容器:
cd xhs_mcp_server
docker-compose up -d
服务将在 http://localhost:8000 运行。
2. 通过 Python 直接运行:
pip install -r xhs_mcp_server/requirements.txt
python xhs_api.py
API 文档
服务器运行后,您可以在以下位置访问 API 文档:
- Swagger UI:
http://localhost:8000/docs - ReDoc:
http://localhost:8000/redoc
✨ 主要特性
- 🌟 支持多客户端
- 🌟 提供小红书操作的 RESTful API
- 🌟 Docker 容器化,方便部署和管理
- 🌟 易于部署和扩展
📚 详细文档
API 端点
服务器提供以下端点:
/clients- 创建和管理小红书客户端实例/clients/{client_id}/note- 通过 ID 获取笔记/clients/{client_id}/note/html- 从 HTML 通过 ID 获取笔记/clients/{client_id}/search/notes- 通过关键词搜索笔记/clients/{client_id}/search/users- 通过关键词搜索用户/clients/{client_id}/user/info- 通过 ID 获取用户信息/clients/{client_id}/user/notes- 获取用户笔记/clients/{client_id}/feed/categories- 获取推荐流分类/clients/{client_id}/feed/{feed_type}- 通过类型获取推荐流/health- 健康检查端点
项目结构
.
├── xhs_mcp_server/ # 主服务器目录
│ ├── app/ # 应用程序核心
│ ├── xhs/ # 小红书API模块
│ ├── Dockerfile # Docker构建文件
│ └── requirements.txt # Python依赖
└── xhs_api.py # API实现
💻 使用示例
基础用法
- 创建客户端:
curl -X POST "http://localhost:8000/clients" \
-H "Content-Type: application/json" \
-d '{"cookie": "your_cookie_here"}'
- 通过 ID 获取笔记:
curl -X POST "http://localhost:8000/clients/client_1/note" \
-H "Content-Type: application/json" \
-d '{"note_id": "your_note_id", "xsec_token": "your_xsec_token"}'
📄 许可证
本项目仅用于教育目的。使用风险自负。
Scan to contact