# gw

**Repository Path**: LRTesthhh/gw

## Basic Information

- **Project Name**: gw
- **Description**: GW 是一个基于 Java 的后端服务项目，主要为前端应用提供 API 接口。该项目具备用户管理、文章发布、文件存储、工具应用管理等功能，并集成了 Redis 缓存、MinIO 文件存储、JWT 认证、定时任务等常用组件。
- **Primary Language**: Unknown
- **License**: Not specified
- **Default Branch**: master
- **Homepage**: None
- **GVP Project**: No

## Statistics

- **Stars**: 3
- **Forks**: 1
- **Created**: 2024-10-09
- **Last Updated**: 2025-08-16

## Categories & Tags

**Categories**: Uncategorized

**Tags**: None

## README



# GW 项目说明文档

## 项目介绍

GW 是一个基于 Java 的后端服务项目，主要为前端应用提供 API 接口。该项目具备用户管理、文章发布、文件存储、工具应用管理等功能，并集成了 Redis 缓存、MinIO 文件存储、JWT 认证、定时任务等常用组件。

## 功能模块

- **用户管理**：登录、注册、修改个人信息、找回密码
- **文章管理**：发布、查看、评论文章
- **工具应用管理**：添加、查询、删除工具应用
- **文件管理**：文件上传、下载、存储桶管理
- **定时任务**：每天早上 8 点更新热门文章

## 技术栈

- Spring Boot
- Redis
- MyBatis
- JWT
- MinIO
- JavaMail

## 模块结构

- `com.gw.controller`：接口定义，包括用户、文章、工具、文件等各类控制器
- `com.gw.service`：服务接口定义
- `com.gw.service.impl`：服务实现类
- `com.gw.mapper`：数据库操作接口
- `com.gw.pojo.dto`：数据传输对象
- `com.gw.pojo.entity`：数据库实体对象
- `com.gw.pojo.vo`：返回给前端的视图对象
- `com.gw.utils`：工具类，如 JWT 工具、MinIO 工具等
- `com.gw.task`：定时任务处理
- `com.gw.config`：系统配置，如 Redis、WebMvc �://gw.git
  - `application.yml`：主配置文件
  - `application-dev.yml`：开发环境配置文件

## 快速开始

### 环境准备

- Java 17 或以上版本
- Maven 3.x
- Redis
- MinIO
- 邮件服务器配置

### 构建与运行

1. 克隆项目：
   ```bash
   git clone https://gitee.com/LRTesthhh/gw
   ```
2. 进入项目目录：
   ```bash
   cd gw
   ```
3. 构建项目：
   ```bash
   mvn clean package
   ```
4. 启动项目：
   ```bash
   java -jar gw-server/target/gw-server.jar
   ```

## 接口文档

请参考项目中的各个控制器类文件，它们分别定义了 RESTful 风格的接口。常用的接口包括：

- 用户登录：`POST /user/login`
- 注册用户：`POST /user/register`
- 发布文章：`POST /post/addPost`
- 获取热门文章：`GET /hot/getEssay`
- 文件上传：`POST /file/upload/{bucketName}`
- 工具应用管理：`POST /util/add` / `GET /util/page`

## 贡献指南

欢迎贡献代码，请确保遵循以下步骤：

1. Fork 本项目
2. 创建新分支
3. 提交代码
4. 创建 Pull Request

## 许可证

本项目使用 MIT 许可证，请查看 LICENSE 文件获取详细信息。