# java-api

**Repository Path**: songge161/java-api

## Basic Information

- **Project Name**: java-api
- **Description**: No description available
- **Primary Language**: Unknown
- **License**: MIT
- **Default Branch**: main
- **Homepage**: None
- **GVP Project**: No

## Statistics

- **Stars**: 0
- **Forks**: 0
- **Created**: 2025-10-06
- **Last Updated**: 2026-04-06

## Categories & Tags

**Categories**: Uncategorized

**Tags**: None

## README

# homecc-javaapi

`homecc-javaapi` 是 `homecc` 体系下的 Java 后端项目，当前目标是先沉淀成一个可持续演进的 API 基础服务，再逐步扩展登录、邀请码、角色权限和单点登录能力。

## 当前状态

- 已从演示级内存 CRUD 重构为基于 Spring Boot + Spring Data JPA 的后端骨架
- 已建立用户领域的基础分层：`controller / dto / entity / repository / service`
- 已补充统一返回结构、全局异常处理、健康检查接口
- 已将数据库配置改成环境变量占位，不再把明文连接信息直接写进仓库
- 已新增项目内中文文档中心，集中记录架构、开发、运维和规划

## 技术栈

- Java 17
- Spring Boot 3.5.6
- Spring Web
- Spring Data JPA
- MySQL
- Spring Validation
- Spring Security Crypto
- H2（测试环境）

## 本地启动

1. 准备数据库并设置环境变量

```bash
export HOMECC_DB_URL='jdbc:mysql://124.223.1.3:3306/javadb?useSSL=false&allowPublicKeyRetrieval=true&serverTimezone=Asia/Shanghai&characterEncoding=UTF-8'
export HOMECC_DB_USERNAME='javadb'
export HOMECC_DB_PASSWORD='666666'
```

2. 启动项目

```bash
./mvnw spring-boot:run
```

3. 健康检查

```bash
curl http://localhost:8080/api/system/health
```

默认启动时会尝试初始化超级管理员账号 `1617788635`。如需覆盖初始密码，可在启动前设置：

```bash
export HOMECC_BOOTSTRAP_ADMIN_PASSWORD='你的管理员初始密码'
```

## 核心接口

- `GET /api/system/health`：服务健康检查
- `GET /api/users`：获取用户列表
- `GET /api/users/{id}`：获取单个用户
- `POST /api/users`：创建用户
- `PUT /api/users/{id}`：更新用户
- `DELETE /api/users/{id}`：删除用户

## 文档入口

完整中文文档见 [doc/文档中心.md](./doc/文档中心.md)。