---
title: 前台 API
description: 前台用户访问的 API 接口
---

# 前台 API

::: info 前台 API 说明

前台用户访问的 API 接口，提供用户注册、登录、个人资料管理等功能。

:::

## API 基础信息

- **基础路径**: `/api/`
- **认证方式**: JWT Bearer Token
- **内容类型**: `application/json`
- **字符编码**: `UTF-8`

## 模块列表

::: tip 自动生成

此文档由后端 Swagger 自动生成，包含最新的 API 接口信息。

:::

## 认证流程

### 获取 Token

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

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

## 响应格式

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

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

## 错误处理

API 错误响应格式：

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

## 状态码说明

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

## 开发工具

### Swagger UI

访问后端 Swagger UI 查看完整的 API 文档和在线测试功能。

### 在线测试

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

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