项目规范文件
接口公共规范
API接口
- （API相关说明）
| 接口相关 | 值 | 备注 |
|---|---|---|
| 接口前缀 | /api | (不分环境使用这个) |
| 开发环境 | /dev-api | 即测试环境 |
| 生产环境 | /prod-api | 即线上环境 |
Token认证
| 接口相关 | 值 | 备注 |
|---|---|---|
| token请求头 | 'Bearer '+'token部分xxx' | -- |
Code码
| 状态码 | 含义 | 示例 | 功能使用 |
|---|---|---|---|
| 200 | OK：请求成功 | HttpStatus.OK | 操作成功 |
| 201 | Created：资源已成功创建 | HttpStatus.CREATED | |
| 204 | No Content：请求成功，但无内容返回 | HttpStatus.NO_CONTENT | |
| 400 | Bad Request：请求无效，服务器无法理解 | HttpStatus.BAD_REQUEST | |
| 401 | Unauthorized：未授权 | HttpStatus.UNAUTHORIZED | 账号密码不正确 |
| 403 | Forbidden：禁止访问 | HttpStatus.FORBIDDEN | |
| 404 | Not Found：资源未找到 | HttpStatus.NOT_FOUND | 资源未找到 |
| 405 | Method Not Allowed：请求方法不被允许 | HttpStatus.METHOD_NOT_ALLOWED | |
| 409 | Conflict：请求冲突 | HttpStatus.CONFLICT | |
| 410 | Gone：资源已永久删除 | HttpStatus.GONE | |
| 422 | Unprocessable Entity：请求格式正确，但无法处理 | HttpStatus.UNPROCESSABLE_ENTITY | |
| 500 | Internal Server Error：服务器内部错误 | HttpStatus.INTERNAL_SERVER_ERROR | |
| 502 | Bad Gateway：无效网关 | HttpStatus.BAD_GATEWAY | |
| 503 | Service Unavailable：服务不可用 | HttpStatus.SERVICE_UNAVAILABLE |
方法规范
后端规范
🍎 采取NestJS Modules命名规范
| 操作 | 接口命名 | 备注 | 非特殊统一命名 |
|---|---|---|---|
| 查询 | getXXX | XXX为资源名称，例如getUsers | getAll |
| 创建 | createXXX | XXX为资源名称，例如createUser | getOne |
| 更新 | updateXXX | XXX为资源名称，例如updateUser | updateOne |
| 删除 | deleteXXX | XXX为资源名称，例如deleteUser | deleteOne |
前端规范
| 接口命名 | 操作 | 备注 |
|---|---|---|
handleQuery() | 搜索查询 | 搜索按钮操作，初始化操作，查询页面为1 |
getList | 分页查询 | 带参数分页查询列表 |
handleAdd | 新增添加 | -- |
handleSubmit | 处理表单提交函数 | -- |
handleSubmit | 处理表单提交函数 | -- |
前端参数规范
CRUD参数
参数名 | 参数值 | 参数名 | 参数值 |
|---|---|---|---|
loading | 遮罩层，true开启，false关闭 | single | 非单个禁用，true禁用，false非禁用 |
ids | 选中数组 [] | multiple | 非多个禁用（true开启，false关闭） |
total | 总条数，默认0 | tableList | 用户表格数据,格式[] |
title | 弹出层标题 | deptOptions | 部门树选项[] |
查询参数
JS
pageNum: 1 //页码数（也就是当前是多少页）
pageSize:10 //页条数（也就是当前页是多少条）
dateRange: "", // 日期范围
deptOptions: [],// 部门树选项表单名称
js
queryForm 查询表单Hooks方法
前端
JS
//表格性别进行条件渲染
judigSex(row, column, cellValue) {
return cellValue == 1 ? '男' : '女';
},
// 表格身高进行条件渲染
judiguserHeight(row, column, cellValue) {
return cellValue+'cm';
},
// 表格体重进行条件渲染
judiguserWeight(row, column, cellValue) {
return cellValue+'kg';
},