快速入门.md•2.74 kB
# 小红书 API 微服务 - 快速入门指南
这个项目将小红书 API 封装成了一个 RESTful API 微服务，可以通过 Docker 轻松部署和使用。
## 功能特点
- 提供小红书操作的 RESTful API 接口
- 支持多客户端同时使用
- 使用 Docker 容器化部署
- 易于部署和扩展
## 系统要求
- Docker
- Docker Compose
## 安装步骤
1. 克隆或下载此仓库
2. 进入项目目录
3. 构建并启动 Docker 容器：
```bash
docker-compose build
docker-compose up -d
```
启动后，API 服务将在 `http://localhost:8000` 可用。
## API 文档
服务启动后，可以通过以下地址访问 API 文档：
- Swagger UI: `http://localhost:8000/docs`
- ReDoc: `http://localhost:8000/redoc`
## 使用示例
### 1. 创建客户端
首先需要创建一个客户端实例，用于与小红书 API 交互：
```bash
curl -X POST "http://localhost:8000/clients" \
-H "Content-Type: application/json" \
-d '{"cookie": "你的小红书cookie"}'
```
成功后会返回一个客户端 ID，例如：`{"client_id": "client_1"}`
### 2. 获取笔记
使用客户端 ID 和笔记 ID 获取笔记内容：
```bash
curl -X POST "http://localhost:8000/clients/client_1/note" \
-H "Content-Type: application/json" \
-d '{"note_id": "笔记ID", "xsec_token": "安全令牌"}'
```
### 3. 搜索笔记
通过关键词搜索笔记：
```bash
curl -X POST "http://localhost:8000/clients/client_1/search/notes" \
-H "Content-Type: application/json" \
-d '{"keyword": "搜索关键词", "page": 1, "page_size": 20}'
```
### 4. 获取用户信息
获取指定用户的信息：
```bash
curl -X POST "http://localhost:8000/clients/client_1/user/info" \
-H "Content-Type: application/json" \
-d '{"user_id": "用户ID"}'
```
## Docker 操作指南
### 构建镜像
```bash
docker-compose build
```
### 启动服务
```bash
docker-compose up -d
```
### 查看日志
```bash
docker-compose logs -f
```
### 停止服务
```bash
docker-compose down
```
## 注意事项
1. 使用前需要有有效的小红书 cookie
2. API 调用可能受到小红书官方限制，请合理使用
3. 本项目仅用于学习和研究目的，使用风险自负
## 常见问题
**Q: 如何获取 cookie?**
A: 可以通过浏览器登录小红书网页版，然后从开发者工具中获取 cookie。
**Q: 为什么请求返回 429 错误?**
A: 这通常意味着 IP 被小红书限制了，可以尝试使用代理或等待一段时间后再试。
**Q: 如何使用代理?**
A: 在创建客户端时可以指定代理，例如：
```json
{
"cookie": "你的cookie",
"proxies": {
"http": "http://proxy.example.com:8080",
"https": "http://proxy.example.com:8080"
}
}
```