# api-doc

**Repository Path**: merlinli/api-doc

## Basic Information

- **Project Name**: api-doc
- **Description**: No description available
- **Primary Language**: Unknown
- **License**: Not specified
- **Default Branch**: master
- **Homepage**: None
- **GVP Project**: No

## Statistics

- **Stars**: 0
- **Forks**: 0
- **Created**: 2024-04-14
- **Last Updated**: 2024-04-14

## Categories & Tags

**Categories**: Uncategorized

**Tags**: None

## README


**coingpt文档**


**简介**：<p>此文档仅供开发人员使用</p>


**HOST**:localhost:8080

**联系人**:coingpt

**Version**:2.0

**接口路径**：/v2/api-docs?group=接口


# user-controller

## 用户信息


**接口描述**:


**接口地址**:`/user/info/{id}`


**请求方式**：`GET`


**consumes**:``


**produces**:`["*/*"]`



**请求参数**：

| 参数名称         | 参数说明     |     in |  是否必须      |  数据类型  |  schema  |
| ------------ | -------------------------------- |-----------|--------|----|--- |
|id| id  | path | true |integer  |    |

**响应示例**:

```json
{
	"code": 0,
	"data": {
		"email": "",
		"id": 0,
		"username": ""
	},
	"message": "",
	"success": true
}
```

**响应参数**:


| 参数名称         | 参数说明                             |    类型 |  schema |
| ------------ | -------------------|-------|----------- |
|code|   |integer(int32)  | integer(int32)   |
|data|   |UserDTO  | UserDTO   |
|message|   |string  |    |
|success|   |boolean  |    |



**schema属性说明**




**UserDTO**

| 参数名称         | 参数说明                             |    类型 |  schema |
| ------------ | ------------------|--------|----------- |
|email |    |string  |    |
|id |    |integer(int64)  |    |
|username |    |string  |    |

**响应状态**:


| 状态码         | 说明                            |    schema                         |
| ------------ | -------------------------------- |---------------------- |
| 200 | OK  |ApiResult«UserDTO»|
| 401 | Unauthorized  ||
| 403 | Forbidden  ||
| 404 | Not Found  ||
## 登录


**接口描述**:


**接口地址**:`/user/login`


**请求方式**：`POST`


**consumes**:`["application/json"]`


**produces**:`["*/*"]`


**请求示例**：
```json
{
	"email": "",
	"password": ""
}
```


**请求参数**：

| 参数名称         | 参数说明     |     in |  是否必须      |  数据类型  |  schema  |
| ------------ | -------------------------------- |-----------|--------|----|--- |
|request| request  | body | true |LoginRequest  | LoginRequest   |

**schema属性说明**



**LoginRequest**

| 参数名称         | 参数说明     |     in |  是否必须      |  数据类型  |  schema  |
| ------------ | -------------------------------- |-----------|--------|----|--- |
|email|   | body | false |string  |    |
|password|   | body | false |string  |    |

**响应示例**:

```json
{
	"code": 0,
	"data": "",
	"message": "",
	"success": true
}
```

**响应参数**:


| 参数名称         | 参数说明                             |    类型 |  schema |
| ------------ | -------------------|-------|----------- |
|code|   |integer(int32)  | integer(int32)   |
|data|   |string  |    |
|message|   |string  |    |
|success|   |boolean  |    |





**响应状态**:


| 状态码         | 说明                            |    schema                         |
| ------------ | -------------------------------- |---------------------- |
| 200 | OK  |ApiResult«string»|
| 201 | Created  ||
| 401 | Unauthorized  ||
| 403 | Forbidden  ||
| 404 | Not Found  ||
## 登出


**接口描述**:


**接口地址**:`/user/logout`


**请求方式**：`POST`


**consumes**:`["application/json"]`


**produces**:`["*/*"]`



**请求参数**：
暂无



**响应示例**:

```json
{
	"code": 0,
	"data": "",
	"message": "",
	"success": true
}
```

**响应参数**:


| 参数名称         | 参数说明                             |    类型 |  schema |
| ------------ | -------------------|-------|----------- |
|code|   |integer(int32)  | integer(int32)   |
|data|   |string  |    |
|message|   |string  |    |
|success|   |boolean  |    |





**响应状态**:


| 状态码         | 说明                            |    schema                         |
| ------------ | -------------------------------- |---------------------- |
| 200 | OK  |ApiResult«string»|
| 201 | Created  ||
| 401 | Unauthorized  ||
| 403 | Forbidden  ||
| 404 | Not Found  ||
## 注册


**接口描述**:


**接口地址**:`/user/register`


**请求方式**：`POST`


**consumes**:`["application/json"]`


**produces**:`["*/*"]`


**请求示例**：
```json
{
	"confirmPassword": "",
	"email": "",
	"password": ""
}
```


**请求参数**：

| 参数名称         | 参数说明     |     in |  是否必须      |  数据类型  |  schema  |
| ------------ | -------------------------------- |-----------|--------|----|--- |
|request| request  | body | true |RegisterRequest  | RegisterRequest   |

**schema属性说明**



**RegisterRequest**

| 参数名称         | 参数说明     |     in |  是否必须      |  数据类型  |  schema  |
| ------------ | -------------------------------- |-----------|--------|----|--- |
|confirmPassword|   | body | false |string  |    |
|email|   | body | false |string  |    |
|password|   | body | false |string  |    |

**响应示例**:

```json
{
	"code": 0,
	"data": "",
	"message": "",
	"success": true
}
```

**响应参数**:


| 参数名称         | 参数说明                             |    类型 |  schema |
| ------------ | -------------------|-------|----------- |
|code|   |integer(int32)  | integer(int32)   |
|data|   |string  |    |
|message|   |string  |    |
|success|   |boolean  |    |





**响应状态**:


| 状态码         | 说明                            |    schema                         |
| ------------ | -------------------------------- |---------------------- |
| 200 | OK  |ApiResult«string»|
| 201 | Created  ||
| 401 | Unauthorized  ||
| 403 | Forbidden  ||
| 404 | Not Found  ||
# 账户接口

## 充值地址


**接口描述**:


**接口地址**:`/account/address`


**请求方式**：`GET`


**consumes**:``


**produces**:`["*/*"]`



**请求参数**：

| 参数名称         | 参数说明     |     in |  是否必须      |  数据类型  |  schema  |
| ------------ | -------------------------------- |-----------|--------|----|--- |
|channel| channel  | query | false |string  |    |

**响应示例**:

```json
{
	"code": 0,
	"data": "",
	"message": "",
	"success": true
}
```

**响应参数**:


| 参数名称         | 参数说明                             |    类型 |  schema |
| ------------ | -------------------|-------|----------- |
|code|   |integer(int32)  | integer(int32)   |
|data|   |string  |    |
|message|   |string  |    |
|success|   |boolean  |    |





**响应状态**:


| 状态码         | 说明                            |    schema                         |
| ------------ | -------------------------------- |---------------------- |
| 200 | OK  |ApiResult«string»|
| 401 | Unauthorized  ||
| 403 | Forbidden  ||
| 404 | Not Found  ||
## 账户余额


**接口描述**:


**接口地址**:`/account/balance`


**请求方式**：`GET`


**consumes**:``


**produces**:`["*/*"]`



**请求参数**：

| 参数名称         | 参数说明     |     in |  是否必须      |  数据类型  |  schema  |
| ------------ | -------------------------------- |-----------|--------|----|--- |
|type| type  | query | false |string  |    |

**响应示例**:

```json
{
	"code": 0,
	"data": {
		"amount": "",
		"originValue": 0,
		"unit": ""
	},
	"message": "",
	"success": true
}
```

**响应参数**:


| 参数名称         | 参数说明                             |    类型 |  schema |
| ------------ | -------------------|-------|----------- |
|code|   |integer(int32)  | integer(int32)   |
|data|   |MoneyBO  | MoneyBO   |
|message|   |string  |    |
|success|   |boolean  |    |



**schema属性说明**




**MoneyBO**

| 参数名称         | 参数说明                             |    类型 |  schema |
| ------------ | ------------------|--------|----------- |
|amount |    |string  |    |
|originValue |    |integer(int64)  |    |
|unit | 可用值:POINT,USDT,WEI   |string  |    |

**响应状态**:


| 状态码         | 说明                            |    schema                         |
| ------------ | -------------------------------- |---------------------- |
| 200 | OK  |ApiResult«MoneyBO»|
| 401 | Unauthorized  ||
| 403 | Forbidden  ||
| 404 | Not Found  ||
## 购买点卡


**接口描述**:


**接口地址**:`/account/buy/point`


**请求方式**：`POST`


**consumes**:`["application/json"]`


**produces**:`["*/*"]`


**请求示例**：
```json
{
	"point": ""
}
```


**请求参数**：

| 参数名称         | 参数说明     |     in |  是否必须      |  数据类型  |  schema  |
| ------------ | -------------------------------- |-----------|--------|----|--- |
|request| request  | body | true |BuyPointRequest  | BuyPointRequest   |

**schema属性说明**



**BuyPointRequest**

| 参数名称         | 参数说明     |     in |  是否必须      |  数据类型  |  schema  |
| ------------ | -------------------------------- |-----------|--------|----|--- |
|point|   | body | false |string  |    |

**响应示例**:

```json
{
	"code": 0,
	"data": "",
	"message": "",
	"success": true
}
```

**响应参数**:


| 参数名称         | 参数说明                             |    类型 |  schema |
| ------------ | -------------------|-------|----------- |
|code|   |integer(int32)  | integer(int32)   |
|data|   |string  |    |
|message|   |string  |    |
|success|   |boolean  |    |





**响应状态**:


| 状态码         | 说明                            |    schema                         |
| ------------ | -------------------------------- |---------------------- |
| 200 | OK  |ApiResult«string»|
| 201 | Created  ||
| 401 | Unauthorized  ||
| 403 | Forbidden  ||
| 404 | Not Found  ||
## 支持点卡列表


**接口描述**:


**接口地址**:`/account/point/list`


**请求方式**：`GET`


**consumes**:``


**produces**:`["*/*"]`



**请求参数**：
暂无



**响应示例**:

```json
{
	"code": 0,
	"data": [
		{
			"point": "",
			"usdt": ""
		}
	],
	"message": "",
	"success": true
}
```

**响应参数**:


| 参数名称         | 参数说明                             |    类型 |  schema |
| ------------ | -------------------|-------|----------- |
|code|   |integer(int32)  | integer(int32)   |
|data|   |array  | PointRelateUSDTResponse   |
|message|   |string  |    |
|success|   |boolean  |    |



**schema属性说明**




**PointRelateUSDTResponse**

| 参数名称         | 参数说明                             |    类型 |  schema |
| ------------ | ------------------|--------|----------- |
|point |    |string  |    |
|usdt |    |string  |    |

**响应状态**:


| 状态码         | 说明                            |    schema                         |
| ------------ | -------------------------------- |---------------------- |
| 200 | OK  |ApiResult«List«PointRelateUSDTResponse»»|
| 401 | Unauthorized  ||
| 403 | Forbidden  ||
| 404 | Not Found  ||
## 账户流水


**接口描述**:


**接口地址**:`/account/serial`


**请求方式**：`POST`


**consumes**:`["application/json"]`


**produces**:`["*/*"]`


**请求示例**：
```json
{
	"accountType": "",
	"currentPage": 0,
	"pageSize": 0,
	"serialType": ""
}
```


**请求参数**：

| 参数名称         | 参数说明     |     in |  是否必须      |  数据类型  |  schema  |
| ------------ | -------------------------------- |-----------|--------|----|--- |
|request| request  | body | true |AccountSerialRequest  | AccountSerialRequest   |

**schema属性说明**



**AccountSerialRequest**

| 参数名称         | 参数说明     |     in |  是否必须      |  数据类型  |  schema  |
| ------------ | -------------------------------- |-----------|--------|----|--- |
|accountType|   | body | false |string  |    |
|currentPage|   | body | false |integer(int32)  |    |
|pageSize|   | body | false |integer(int32)  |    |
|serialType|   | body | false |string  |    |

**响应示例**:

```json
{
	"code": 0,
	"data": {
		"list": [
			{
				"amount": {
					"amount": "",
					"originValue": 0,
					"unit": ""
				},
				"recordTime": "",
				"serialNo": "",
				"title": ""
			}
		],
		"total": 0
	},
	"message": "",
	"success": true
}
```

**响应参数**:


| 参数名称         | 参数说明                             |    类型 |  schema |
| ------------ | -------------------|-------|----------- |
|code|   |integer(int32)  | integer(int32)   |
|data|   |SearchResult«AccountSerialResponse»  | SearchResult«AccountSerialResponse»   |
|message|   |string  |    |
|success|   |boolean  |    |



**schema属性说明**




**SearchResult«AccountSerialResponse»**

| 参数名称         | 参数说明                             |    类型 |  schema |
| ------------ | ------------------|--------|----------- |
|list |    |array  | AccountSerialResponse   |
|total |    |integer(int64)  |    |

**AccountSerialResponse**

| 参数名称         | 参数说明                             |    类型 |  schema |
| ------------ | ------------------|--------|----------- |
|amount |    |MoneyBO  | MoneyBO   |
|recordTime |    |string(date-time)  |    |
|serialNo |    |string  |    |
|title |    |string  |    |

**MoneyBO**

| 参数名称         | 参数说明                             |    类型 |  schema |
| ------------ | ------------------|--------|----------- |
|amount |    |string  |    |
|originValue |    |integer(int64)  |    |
|unit | 可用值:POINT,USDT,WEI   |string  |    |

**响应状态**:


| 状态码         | 说明                            |    schema                         |
| ------------ | -------------------------------- |---------------------- |
| 200 | OK  |ApiResult«SearchResult«AccountSerialResponse»»|
| 201 | Created  ||
| 401 | Unauthorized  ||
| 403 | Forbidden  ||
| 404 | Not Found  ||
## 提现


**接口描述**:


**接口地址**:`/account/withdraw`


**请求方式**：`POST`


**consumes**:`["application/json"]`


**produces**:`["*/*"]`


**请求示例**：
```json
{
	"address": "",
	"channel": "",
	"number": "",
	"password": ""
}
```


**请求参数**：

| 参数名称         | 参数说明     |     in |  是否必须      |  数据类型  |  schema  |
| ------------ | -------------------------------- |-----------|--------|----|--- |
|request| request  | body | true |WithdrawRequest  | WithdrawRequest   |

**schema属性说明**



**WithdrawRequest**

| 参数名称         | 参数说明     |     in |  是否必须      |  数据类型  |  schema  |
| ------------ | -------------------------------- |-----------|--------|----|--- |
|address|   | body | false |string  |    |
|channel|   | body | false |string  |    |
|number|   | body | false |string  |    |
|password|   | body | false |string  |    |

**响应示例**:

```json
{
	"code": 0,
	"data": "",
	"message": "",
	"success": true
}
```

**响应参数**:


| 参数名称         | 参数说明                             |    类型 |  schema |
| ------------ | -------------------|-------|----------- |
|code|   |integer(int32)  | integer(int32)   |
|data|   |string  |    |
|message|   |string  |    |
|success|   |boolean  |    |





**响应状态**:


| 状态码         | 说明                            |    schema                         |
| ------------ | -------------------------------- |---------------------- |
| 200 | OK  |ApiResult«string»|
| 201 | Created  ||
| 401 | Unauthorized  ||
| 403 | Forbidden  ||
| 404 | Not Found  ||