---
title: API 总览
description: WWJCloud 框架 API 接口总览
---

# API 总览

::: info API 文档说明

WWJCloud 框架提供完整的 RESTful API 接口，支持前台用户访问和后台管理功能。

:::

## API 分类

### 🎯 前台 API (`/api/`)

前台用户访问的 API 接口，提供用户端功能：

- **会员管理** - 用户注册、登录、个人资料管理
- **认证授权** - JWT 认证、权限验证
- **业务功能** - 各种业务模块的前台接口

### 🔧 后台 API (`/adminapi/`)

后台管理员访问的 API 接口，提供管理功能：

- **会员管理** - 会员列表、详情、状态管理
- **管理员管理** - 管理员账户、权限管理
- **系统管理** - 系统配置、菜单管理、权限管理

## API 访问地址

### 开发环境

```bash
# 前台 API 文档
http://localhost:3000/api/frontend

# 后台 API 文档  
http://localhost:3000/api/admin

# 统一 API 文档
http://localhost:3000/api
```

### 生产环境

```bash
# 前台 API 文档
https://your-domain.com/api/frontend

# 后台 API 文档
https://your-domain.com/api/admin

# 统一 API 文档
https://your-domain.com/api
```

## 认证方式

### JWT 认证

所有需要认证的 API 都使用 JWT Token：

```http
Authorization: Bearer <your-jwt-token>
```

### 获取 Token

#### 前台用户登录

```http
POST /api/member/login
Content-Type: application/json

{
  "username": "user@example.com",
  "password": "password123"
}
```

#### 后台管理员登录

```http
POST /adminapi/admin/login
Content-Type: application/json

{
  "username": "admin",
  "password": "admin123"
}
```

## 响应格式

所有 API 都遵循统一的响应格式：

```json
{
  "code": 200,
  "message": "success",
  "data": {
    // 具体数据
  }
}
```

## 错误处理

API 错误响应格式：

```json
{
  "code": 400,
  "message": "参数错误",
  "data": null
}
```

## 分页查询

支持分页的 API 使用统一的查询参数：

```http
GET /api/member?page=1&limit=10&sort=create_time&order=desc
```

## 状态码说明

| 状态码 | 说明 |
|--------|------|
| 200 | 请求成功 |
| 201 | 创建成功 |
| 400 | 请求参数错误 |
| 401 | 未授权 |
| 403 | 禁止访问 |
| 404 | 资源不存在 |
| 500 | 服务器内部错误 |

## 开发工具

### Swagger UI

每个 API 分组都提供 Swagger UI 界面，支持：

- API 文档查看
- 在线测试
- 参数验证
- 响应示例

### Postman 集合

可以导入 Postman 集合进行 API 测试：

```bash
# 导出 Swagger JSON
curl http://localhost:3000/api-json > api.json
```

## 版本控制

当前 API 版本：`v1.0.0`

版本控制策略：
- 向后兼容的更新：小版本号递增
- 破坏性更新：大版本号递增
- 通过 URL 路径进行版本控制：`/api/v1/`

## 限流策略

API 访问限流规则：

- **前台 API**：1000 次/小时/用户
- **后台 API**：5000 次/小时/管理员
- **登录接口**：10 次/分钟/IP

## 监控和日志

- **访问日志**：记录所有 API 访问
- **错误日志**：记录 API 错误信息
- **性能监控**：API 响应时间监控
- **使用统计**：API 调用频率统计 