数据库设计规范
- 表设计规范
- 表名全部小写,单词间通过'_'间隔
- 主键命名为'id',类型为Long,长度为20位,`非自增`
2. 外键及索引命名规范
- 唯一索引:ux_表名_索引字段。如:ux_resource_code
- 普通索引:ix_表名_索引字段。如:ix_role_name
- 外键命名:fk_表名_字段名。如:fk_orders_product_id
字段长度规则
| 名称类 | 类型 | 长度 | 备注 | 默认值 |
|--------|---------|--------|-------------|---------|
| 编号 |bigint | 20 | | |
| 账号类 | varchar | 100 | 如email,username | |
| 状态类 | varchar | 5 | 如订单状态等 | |
| 名称类 | varchar | 200 | 中文名称,如产品名 ||
| 手机电话| varchar | 20 | | |
| 描述简介| varchar | 500 | | |
| 网址类 | varchar | 500 | 如url | |
| 时间类 | datetime | | | now() | |
URL和方法命名规范
RESTFUL URL命名规范
API URI design
API URI 设计最重要的一个原则: nouns (not verbs!) ,名词(而不是动词)。
`POST & PUT 方法的接口前后端统一mediaType类型为:application/json;charset=UTF-8`
CRUD 简单 URI:
| 方法 | URL | 功能 |
|--------|-----------|------------------|
| GET | /users | 获取用户列表 |
| GET | /users/1 | 获取 id 为 1 的用户|
| POST | /users | 创建一个用户 |
| PUT | /users/1 | 替换 id 为 1 的用户|
| DELETE | /users/1 | 删除 id 为 1 的用户|