# SodaAuth

**Repository Path**: niocho/SodaAuth

## Basic Information

- **Project Name**: SodaAuth
- **Description**: 使用Spring Boot实现的具有完整功能的皮肤站，同时兼顾Yggdrasil API！
- **Primary Language**: Java
- **License**: GPL-3.0
- **Default Branch**: master
- **Homepage**: None
- **GVP Project**: No

## Statistics

- **Stars**: 0
- **Forks**: 0
- **Created**: 2020-02-27
- **Last Updated**: 2021-11-03

## Categories & Tags

**Categories**: Uncategorized

**Tags**: None

## README

# SodaAuth
下一代我的世界皮肤站。
## 约定
邮箱规则：
```regexp
^[a-zA-Z0-9_-]+@[a-zA-Z0-9_-]+(\.[a-zA-Z0-9_-]+)+$
```
无符号UUID：无符号UUID应该是一个标准的JavaUUID去掉 - 得到的字符串，他应该是一个拥有32个字符的可能出现各种字母和数字的字符串
```regexp
^[a-z0-9]{32}$
```
密码规则：密码应当包含数字,英文,字符中的两种以上，长度8-20
```regexp
^(?![0-9]+$)(?![a-z]+$)(?![A-Z]+$)(?!([^(0-9a-zA-Z)])+$).{8,20}$
```
用户角色名规则
```regexp
^\w{3,16}$
```
密码爆破防御间隔：服务器默认使用 60s 进行防御，即用户在60s内只能进行三次尝试
## 后端接口
### 通用RESTful API返回格式
```json5
{
  "status": 200,
  "message": "",
  "error_message": "",
  "data": {}
}
```
- status 代表此次请求的状态，可以在后面的表中查到
- message 代表除错误外传递的可读信息
- error_message 代表出错误后的可读信息
- data 为此次请求获取到的数据，如果这次请求并不具备该项则可以省略
### 用户相关
#### /api/user/create
创建用户接口

status 参数对照表
```yaml
200: 创建成功
201: 创建失败，参数绑定问题
202: 创建失败，服务器内部问题
203: 创建失败，用户创建了过多的账户
```
#### /api/user/update
更新用户信息接口
```yaml
300: 创建成功
301: 创建失败，参数绑定问题
302: 创建失败，服务器内部问题
```
#### /api/user/delete
删除用户接口
```yaml
400: 删除成功
401: 删除失败，参数绑定问题
402: 创建失败，服务器内部问题
```
#### /api/user/info
获取用户信息接口
### 角色相关
#### /api/profile/create
```yaml
500: 角色创建成功
501: 角色创建失败，这个用户已经存在
502: 角色创建失败，服务器内部错误
```
#### /api/profile/update
#### /api/profile/delete
#### /api/profile/info
### 材质相关
#### /api/textures/upload
用户上载材质
#### /api/textures/delete
用户删除自己拥有材质
### 管理面板
#### /api/admin/