Skip to content

Commit 76f301b

Browse files
committed
修定文档,数据库规范
1 parent 8dd8828 commit 76f301b

File tree

2 files changed

+21
-21
lines changed

2 files changed

+21
-21
lines changed

auth/readme.md

+5-5
Original file line numberDiff line numberDiff line change
@@ -167,8 +167,8 @@ eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9.eyJ1c2VyX25hbWUiOiJhZG1pbiIsInNjb3BlIjpbInJ
167167
| 表名 | 简介 | 备注 |
168168
|------------|---------------|-------------------------|
169169
| users | 用户表 | 使用应用的用户 |
170-
| groups | 组织表 | 通过users_groups_relation与users关联,多对多 |
171-
| positions | 岗位表 | 通过users_positions_relation与users关联,多对多 |
172-
| roles | 角色表 | 通过users_roles_relation与users关联,多对多 |
173-
| menus | 菜单表 | 通过roles_menus_relation与roles关联,多对多 |
174-
| resources | 资源表 | 通过roles_resources_relation与roles关联,多对多 |
170+
| groups | 组织表 | 通过user_group_relation与users关联,多对多 |
171+
| position | 岗位表 | 通过user_position_relation与users关联,多对多 |
172+
| roles | 角色表 | 通过user_role_relation与users关联,多对多 |
173+
| menu | 菜单表 | 通过role_menu_relation与roles关联,多对多 |
174+
| resource | 资源表 | 通过role_resource_relation与roles关联,多对多 |

docs/pattern.md

+16-16
Original file line numberDiff line numberDiff line change
@@ -5,7 +5,7 @@
55

66
1、表名全部小写,单词间通过'_'间隔
77

8-
2、主键命名为'id',pg库类型为serial自增长主键,会默认创建名为[表名_id_seq]的序列
8+
2、主键命名为'id',varchar(20),不使用数据库的序列,应用生成全局序列。
99

1010
3、必须包含4个审计字段且不能为空。created_time、updated_time、created_by、updated_by。
1111

@@ -32,7 +32,7 @@
3232
| 手机电话| varchar | 20 | |
3333
| 描述简介| varchar | 500 | |
3434
| 网址类 | varchar | 500 | 如url |
35-
| 时间类 | timestamp | | |
35+
| 时间类 | datetime | | |
3636

3737

3838
## URL和方法命名规范
@@ -46,23 +46,23 @@ CRUD 简单 URI:
4646

4747
| 方法 | URL | 功能 |
4848
|--------|-----------|------------------|
49-
| GET | /users | 获取用户列表 |
50-
| GET | /users/1 | 获取 id 为 1 的用户|
51-
| POST | /users | 创建一个用户 |
52-
| PUT | /users/1 | 替换 id 为 1 的用户|
53-
| PATCH | /users/1 | 修改 id 为 1 的用户|
54-
| DELETE | /users/1 | 删除 id 为 1 的用户|
49+
| GET | /user | 获取用户列表 |
50+
| GET | /user/1 | 获取 id 为 1 的用户|
51+
| POST | /user | 创建一个用户 |
52+
| PUT | /user/1 | 替换 id 为 1 的用户|
53+
| PATCH | /user/1 | 修改 id 为 1 的用户|
54+
| DELETE | /user/1 | 删除 id 为 1 的用户|
5555

5656
上面是对某一种资源进行操作的 URI,那如果是有关联的资源,或者称为级联的资源,该如何设计 URI 呢?比如某一用户下的产品:
5757

5858
| 方法 | URL | 功能 |
5959
|--------|---------------------|------------------------------------|
60-
| GET | /users/1/products | 获取 Id 为 1 用户下的产品列表 |
61-
| GET | /users/1/products/2 | 获取 Id 为 1 用户下 Id 为 2 的产品 |
62-
| POST | /users/1/products | 在 Id 为 1 用户下,创建一个产品 |
63-
| PUT | /users/1/products/2 | 在 Id 为 1 用户下,替换 Id 为 2 的产品|
64-
| PATCH | /users/1/products/2 | 修改 Id 为 1 的用户下 Id 为 2 的产品 |
65-
| DELETE | /users/1/products/2 | 删除 Id 为 1 的用户下 Id 为 2 的产品 |
60+
| GET | /user/1/product | 获取 Id 为 1 用户下的产品列表 |
61+
| GET | /user/1/product/2 | 获取 Id 为 1 用户下 Id 为 2 的产品 |
62+
| POST | /user/1/product | 在 Id 为 1 用户下,创建一个产品 |
63+
| PUT | /user/1/product/2 | 在 Id 为 1 用户下,替换 Id 为 2 的产品|
64+
| PATCH | /user/1/product/2 | 修改 Id 为 1 的用户下 Id 为 2 的产品 |
65+
| DELETE | /user/1/product/2 | 删除 Id 为 1 的用户下 Id 为 2 的产品 |
6666

6767
### 方法命名规范
6868

@@ -99,10 +99,10 @@ CRUD 简单 URI:
9999
| 操作 | 例子 | 备注 |
100100
|--------|---------------------|----------------------------------|
101101
| 增加 | add | |
102-
| 获取 | get | 获取到单条记录 |
102+
| 保存 | save | 更新,不存在则新增 |
103103
| 删除 | remove/delete | |
104+
| 获取 | get | 获取到单条记录 |
104105
| 更新 | update | 更新存在的记录 |
105-
| 保存 | save | 更新,不存在则新增 |
106106
| 查询 | query | 根据id等简单条件查询 |
107107
| 搜索 | search | 根据时间范围或模糊搜索 |
108108

0 commit comments

Comments
 (0)