# 前端规范

**Repository Path**: firefly0_0/api-specification

## Basic Information

- **Project Name**: 前端规范
- **Description**: 前端通用接口规范..
- **Primary Language**: HTML
- **License**: MulanPSL-2.0
- **Default Branch**: master
- **Homepage**: None
- **GVP Project**: No

## Statistics

- **Stars**: 0
- **Forks**: 0
- **Created**: 2023-06-14
- **Last Updated**: 2023-07-18

## Categories & Tags

**Categories**: Uncategorized

**Tags**: None

## README

# api规范

## 路由前缀 /api
- 管理端api前缀 /api/admin
- 客户端api前缀 /api/app

## 响应结构
```json
	{
		"code": 1000, // 成功 1000, 通用异常 1001, 验证异常 1002, 核心异常 1003
		"message": "success", // 异常信息
		"data": {}, // 响应数据
		"key": "value" // 其他数据
	}
```
## 登录/login
```json
// 响应
{
    "code": 1000,
    "message": "success",
    "data": {
        "expire": 7200,
        "token": "eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9.eyJpc1JlZnJlc2giOmZhbHNlLCJyb2xlSWRzIjpbIjEiXSwidXNlcm5hbWUiOiJhZG1pbiIsInVzZXJJZCI6MSwicGFzc3dvcmRWZXJzaW9uIjo3LCJpYXQiOjE2ODY3MTIyMjIsImV4cCI6MTY4NjcxOTQyMn0.cPcpMYzviuU0RjXsc09PwuiZynNDgtAVWbm7wZb9iEU",
        "refreshExpire": 1296000,
        "refreshToken": "eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9.eyJpc1JlZnJlc2giOnRydWUsInJvbGVJZHMiOlsiMSJdLCJ1c2VybmFtZSI6ImFkbWluIiwidXNlcklkIjoxLCJwYXNzd29yZFZlcnNpb24iOjcsImlhdCI6MTY4NjcxMjIyMiwiZXhwIjoxNjg4MDA4MjIyfQ.vazmKGTuALzMMfmOqVIssoMf4MiSNJZxP8HBcUlnzAI"
    }
}
```
## 通用 CRUD ["add", "delete", "update", "info", "list", "page", "tree", "import", "export"]
### 对应的接口
1. POST /demo/xxx/add 新增
```json
 // Body
 {
	 "key": "value" // 其他数据
 }
 // 响应
 {
 	"code": 1000, 
 	"message": "success"
 }
```
2. POST /demo/xxx/delete 删除
```json
 // Body
 {
	 ids: ["id1", "id2"] // id数组
 }
 // 响应
 {
 	"code": 1000, 
 	"message": "success"
 }
```
3. POST /demo/xxx/update 更新
```json
 // Body
 {
	 "id": "id",
	 "key": "value" // 其他数据
 }
 // 响应
 {
 	"code": 1000, 
 	"message": "success"
 }
```
4. GET  /demo/xxx/info 信息详情
```json
 // Params
 {
	 "id": "id"
 }
 // 响应
 {
 	"code": 1000, 
	"data": {
		"id": "id",
		"key": "value" // 其他数据
	},
 	"message": "success"
 }
```
5. POST /demo/xxx/list 列表信息
 ```json
 // Body
 {
 	"keyWord": "商品标题", // 模糊搜索，搜索的字段对应keyWordLikeFields
 	"type": 1, // 全等于筛选，对应fieldEq
	"timeInterval": ["startTime", "endTime"], // 时间区间筛选
 	"sort": "desc", // 排序方向
 	"order": "id", // 排序字段
 }
 // 响应
 {
 	"code": 1000,
 	"message": "success",
 	"data": [
 			{
 				"id": 4,
 				"createTime": "2021-03-12 16:23:46",
 				"updateTime": "2021-03-12 16:23:46",
 				"title": "这是一个商品",
 				"price": "99.00",
 				"userId": 1,
 				"type": 1,
 			}
 		],
 }
 ```
6. POST /demo/xxx/page 分页查询(包含模糊查询、字段全匹配等)
```json
	// Body
	{
		"keyWord": "商品标题",
		"type": 1,
		"timeInterval": ["startTime", "endTime"],
		"page": 2, // 第几页
		"size": 1, // 每页返回个数
		"sort": "desc",
		"order": "id",
	}
	// 响应
	{
		"code": 1000,
		"message": "success",
		"data": {
			"list": [
				{
					"id": 4,
					"createTime": "2021-03-12 16:23:46",
					"updateTime": "2021-03-12 16:23:46",
					"title": "这是一个商品",
					"price": "99.00",
					"userId": 1,
					"type": 1,
				}
			],
			"pagination": {
				"page": 2, // 当前页数
				"size": 1, // 每页条数
				"total": 4 // 总条数
			}
		}
	}
	```
7. GET  /demo/xxx/tree 树形列表信息
```json
 // Params
 {
	 "id": "id"
 }
 // 响应
 {
 	"code": 1000, 
  "data": [{
  		"label": "一级 1",
  		"id": "id",
  		"children": [{
  			"label": "二级 1-1",
  			"id": "id",
  			"children": [{
  				"label": "三级 1-1-1",
  				"id": "id"
  			}]
  		}]
  	},
  	{
  		"label": "一级 2",
  		"id": "id",
  		"children": [{
  				"label": "二级 2-1",
  				"id": "id",
  				"children": [{
  					"label": "三级 2-1-1",
  					"id": "id"
  				}]
  			},
  			{
  				"label": "二级 2-2",
  				"id": "id",
  				"children": [{
  					"label": "三级 2-2-1",
  					"id": "id"
  				}]
  			}
  		]
  	}
  ],
	"message": "success"
 }
```
8. POST /demo/xxx/import 导入
```json
 // Body
 {
	 "file": "xxxxx.xlsx"
 }
 // 响应
 {
 	"code": 1000, 
 	"message": "success"
 }
```
9. POST /demo/xxx/export 导出
```json
 // Body
 {}
 // 响应
 {
 	"code": 1000, 
	"data": "http://xxxx.xlsx",
 	"message": "success"
 }
```