# blind-box-for-java

**Repository Path**: fengjian2000/blind-box-for-java

## Basic Information

- **Project Name**: blind-box-for-java
- **Description**: 盲盒后端 java 开发接口
- **Primary Language**: Unknown
- **License**: Not specified
- **Default Branch**: master
- **Homepage**: None
- **GVP Project**: No

## Statistics

- **Stars**: 0
- **Forks**: 2
- **Created**: 2023-03-14
- **Last Updated**: 2023-03-14

## Categories & Tags

**Categories**: Uncategorized

**Tags**: None

## README

> This documentation is generated by [JApiDocs](https://japidocs.agilestudio.cn/).
---

# 盲盒接口

## 放入盲盒

*作者: huixh*

**请求URL**

/box/put `PUT`

**请求体**

```json
{
  "message": "string //简介",
  "sex": "string //性别",
  "weChatNumber": "string //微信号",
  "files": "string[]"
}
```

**返回结果**

```json
{
  "status": "int //操作状态码",
  "message": "string //操作状态信息",
  "data": "string //操作结果数据",
  "timestamp": "long //操作时间戳"
}
```

## 随机获取

*作者: huixh*

**请求URL**

/box/get/{sex} `GET`

**请求参数**

参数名|类型|必须|描述 --:|:--:|:--:|:-- sex|string|是|性别

**返回结果**

```json
{
  "status": "int //操作状态码",
  "message": "string //操作状态信息",
  "data": {
    "noteId": "string //纸条id",
    "noteContent": "string //简单介绍",
    "noteImg": "string[] //图片 id 列表",
    "datetime": "string"
  },
  "timestamp": "long //操作时间戳"
}
```

## 获取自身 文章

*作者: huixh*

**请求URL**

/box/get/self `GET`

**请求参数**

参数名|类型|必须|描述 --:|:--:|:--:|:-- token|string|否|token

**返回结果**

```json
{
  "status": "int //操作状态码",
  "message": "string //操作状态信息",
  "data": [
    {
      "noteId": "string //纸条id",
      "noteContent": "string //简单介绍",
      "noteImg": "string[] //图片 id 列表",
      "datetime": "string"
    }
  ],
  "timestamp": "long //操作时间戳"
}
```

# 文件接口

## 图片上传

*作者: huixh*

**请求URL**

/file/upload `POST`

**请求参数**

参数名|类型|必须|描述 --:|:--:|:--:|:-- token|string|否|token 令牌 file|file|否|上传文件对象 md5|string|否|文件 MD5值

**返回结果**

```json
{
  "status": "int //操作状态码",
  "message": "string //操作状态信息",
  "data": {
    "url": "string //图片地址",
    "fileId": "string //文件id 用于删除和文章记录"
  },
  "timestamp": "long //操作时间戳"
}
```

## 返回图片

*作者: huixh*

**请求URL**

/file/url/img/{fileId} `GET`

**请求参数**

参数名|类型|必须|描述 --:|:--:|:--:|:-- fileId|string|是|文件id

**返回结果**

```json
返回图像
```

## 取消上传

*作者: huixh*

**请求URL**

/file/delete/{fileId} `DELETE`

**返回结果**

```json
{
  "status": "int //操作状态码",
  "message": "string //操作状态信息",
  "data": "string //操作结果数据",
  "timestamp": "long //操作时间戳"
}
```

# 登录接口

## 登录

*作者: huixh*

**请求URL**

/login/login `POST`

**请求体**

```json
{
  "email": "string //用户邮箱",
  "code": "string //用户验证码"
}
```

**返回结果**

```json
{
  "status": "int //操作状态码",
  "message": "string //操作状态信息",
  "data": {
    "token": "string //用户登录token",
    "messages": "string //用户消息提示"
  },
  "timestamp": "long //操作时间戳"
}
```

## 发送用户登录验证码

*作者: huixh*

**请求URL**

/login/sendMail `POST`

**请求参数**

参数名|类型|必须|描述 --:|:--:|:--:|:-- email|string|否|用户邮箱

**返回结果**

```json
{
  "status": "int //操作状态码",
  "message": "string //操作状态信息",
  "data": "string //操作结果数据",
  "timestamp": "long //操作时间戳"
}
```