# base-backend-api

**Repository Path**: czleing/base-backend-api

## Basic Information

- **Project Name**: base-backend-api
- **Description**: 基于若依后台管理系统修改
- **Primary Language**: Unknown
- **License**: MIT
- **Default Branch**: master
- **Homepage**: None
- **GVP Project**: No

## Statistics

- **Stars**: 4
- **Forks**: 0
- **Created**: 2024-01-29
- **Last Updated**: 2026-06-07

## Categories & Tags

**Categories**: Uncategorized

**Tags**: None

## README

# base-api
### [若依-单体-后端服务](https://gitee.com/y_project/RuoYi)
### 后台管理系统

### 基于若依单体后端服务，做了一些修改，规范了一些字段类型、命名和使用方式，如下：
- 化繁为简，去掉了 RestFull 规范，统一使用 Post 请求
- 去掉多余的 Service 接口层 IXxxService
- 是否类字段统一使用 Boolean 类型，字段名统一使用 isXxxx 命名，数据库统一用 tinyint(1)
- 规范 0、1 的意义，统一使用 0 代表否定，1 代表肯定
- 数据表主键字段后续统一命名为 id，状态 status 的[0=正常、1=停用]统一改为是否启用 is_enabled[true、false]
- 去掉了多余的 ruoyi 前缀，更适合各个企业和项目免改使用
- 重构了代码生成模块，增加了一些配置，新增和替换了模板，SQL自动执行，菜单自动删除和新增，生成路径更智能等
- 引入 springdoc-openapi 自动生成接口文档
- 重构了请求的参数解析与返回，VO、BO、ENTITY及相关父类继承关系，减少接口文档中因继承出现的不相关的字段信息
- 整合了日期范围和分页参数到统一的参数接收类中，不再独立去接收，并规范日期范围字段的命名方式
- 其他优化

### 注意事项
#### 1、数据库设计注意事项
- 是否类字段类型使用 `tinyint(1)`，对应 java 里使用 `Boolean`
- 用于 CRUD 的表必须加以下字段： `create_by`, `create_time`, `update_by`, `update_time`，需要逻辑删除则需加 `is_deleted` 字段
- 需关联字典的字段，统一使用字符类型 `varchar(xx)`