# bailian_api_server

**Repository Path**: mikezz/bailian_api_server

## Basic Information

- **Project Name**: bailian_api_server
- **Description**: 阿里百炼api服务器
- **Primary Language**: JavaScript
- **License**: Not specified
- **Default Branch**: master
- **Homepage**: None
- **GVP Project**: No

## Statistics

- **Stars**: 1
- **Forks**: 0
- **Created**: 2025-04-22
- **Last Updated**: 2025-04-22

## Categories & Tags

**Categories**: Uncategorized

**Tags**: None

## README

# 百炼 API 服务器

一个用于与阿里云百炼 AI 服务通信的 Node.js 服务器。

## 设置

1. 安装依赖：
   ```
   npm install
   ```

2. 配置环境变量：
   - 复制 `.env` 文件并更新为你的阿里云凭证
   - 你需要设置：
     - `DASHSCOPE_API_KEY`：你的阿里云 DashScope API 密钥
     - `ALIBABA_CLOUD_ACCESS_KEY_SECRET`：你的阿里云访问密钥密钥（可选）
     - `BAILIAN_MODEL_ID`：你想要使用的模型 ID（默认：qwen-max）
     - `PORT`：（可选）运行服务器的端口（默认：3001）

3. 启动服务器：

   **使用启动脚本（推荐）：**

   我们提供了启动脚本，可以自动检测端口是否被占用，如果占用则先杀掉占用进程，然后启动服务器。

   Windows：
   ```
   .\start-server.bat
   ```

   Linux/macOS：
   ```
   chmod +x ./start-server.sh
   ./start-server.sh
   ```

   **直接启动：**
   ```
   npm start
   ```

   **使用自动重启进行开发：**
   ```
   npm run dev
   ```

## 测试页面

服务器内置了一个 Web 测试页面，可以方便地测试百炼 API 的功能。

1. 启动服务器后，在浏览器中访问：
   ```
   http://localhost:3001
   ```

2. 测试页面包含两个主要功能：
   - **文本生成**：测试百炼 API 的文本补全能力
   - **对话生成**：与百炼 AI 进行多轮对话

3. 测试页面还显示 API 请求和响应的详细信息，方便调试

有关测试页面的详细使用说明，请参阅 [测试页面指南](./doc/test-page-guide.md)。

## API 端点

### 状态检查
```
GET /api/bailian/status
```

### 文本生成
```
POST /api/bailian/completion
```

请求体：
```json
{
  "prompt": "从前有座山",
  "maxTokens": 1024,
  "temperature": 0.7
}
```

### 对话生成
```
POST /api/bailian/chat
```

请求体：
```json
{
  "messages": [
    {"role": "user", "content": "你好，请介绍一下自己"}
  ],
  "maxTokens": 1024,
  "temperature": 0.7
}
```

## 注意事项

- 确保保管好你的 API 密钥，永远不要将它们提交到版本控制系统中
- 服务器包含对跨域请求的 CORS 支持
- 所有 API 端点都实现了错误处理
- 服务器默认运行在端口 3001，可以通过环境变量 `PORT` 或者修改 `server.js` 文件来更改
- 如果使用官方 DashScope 兼容模式 API，需要设置环境变量 `DASHSCOPE_API_KEY`

## 文档

详细文档位于 `doc` 目录中：

- [项目介绍](./doc/project-introduction.md) - 项目的详细介绍和架构说明
- [API 文档](./doc/api-documentation.md) - API 端点的详细说明和使用方法
- [更新日志](./doc/changelog.md) - 项目的版本历史和更新记录
- [开发指南](./doc/development-guide.md) - 开发者指南和最佳实践
- [文档同步指南](./doc/doc-sync-guide.md) - 如何在更新代码时同步更新文档

## 文档同步

每次更新代码时，请确保同步更新相关文档。详细的文档同步指南请参见 [文档同步指南](./doc/doc-sync-guide.md)。