Files
hera/README.md
T

43 lines
1.9 KiB
Markdown

# Hera 后端
Spring Boot 后端,提供微信小程序登录、手机号验证码绑定、用户资料、协议、关注我们和吉分兑换状态接口。
命理计算使用 `cn.6tail:lunar` 根据公历生日和时辰生成四柱八字,再计算五行分布、日主、喜用和忌用。
元宝页提供今日卡牌、每日生活小贴士、卡牌置顶等接口。
## 本地启动
```bash
export WECHAT_APP_ID=wxa76a2ef9e8ba612e
export WECHAT_APP_SECRET=266bb34a7186a4b835186141516efb78
export DB_URL='jdbc:mysql://101.43.139.56:3306/hera?useUnicode=true&characterEncoding=UTF-8&serverTimezone=Asia/Shanghai&useSSL=false&allowPublicKeyRetrieval=true'
export DB_USERNAME=hera_user
export DB_PASSWORD='请通过部署环境配置'
mvn spring-boot:run
```
默认地址:`http://localhost:8080`
## 开发说明
- 当前已默认关闭微信 mock,并接入微信 `jscode2session`。
- 数据持久层使用 MyBatis Mapper XML,首次启动会执行 `schema.sql` 创建缺失的数据表。
- 数据库连接默认指向 `101.43.139.56:3306/hera`,生产部署建议通过 `DB_URL`、`DB_USERNAME`、`DB_PASSWORD` 覆盖。
- `WECHAT_APP_SECRET` 请优先使用服务器环境变量配置,不建议提交到公开仓库。
- `/api/auth/sms` 开发阶段返回 `mockCode`,接入短信厂商后移除返回值。
- 正式上线前需要替换 `hera.jwt-secret`、短信服务实现和协议正文。
## 数据表 CRUD
以下接口均需要携带 `Authorization: Bearer <token>`,并支持统一操作:
- `GET /api/data/{resource}/{id}`:按主键查询
- `GET /api/data/{resource}?offset=0&limit=20`:分页列表,`limit` 最大为 100
- `POST /api/data/{resource}`:新增
- `PUT /api/data/{resource}/{id}`:更新
- `DELETE /api/data/{resource}/{id}`:删除
`resource` 可取 `nfc-chips`、`user-accounts`、`user-profiles`、`virtual-items`、
`user-virtual-items`、`offerings`、`transfers`。