README.md 添加接口参数约束

README.md

@@ -13,8 +13,7 @@
 - 提供出去的feign api，要自己注入spring容器
 
 # 项目结构
-## 模块层级
+
-![img.png](img.png)
 
 ## 模块描述
 
@@ -25,6 +24,20 @@
 `orgmanax-infra` | 基础设施层，隔离非业务变化，防止外部变化引起内部业务变更。<br/>对接外部依赖，数据库，MQ等中件间                                  | `orgmanax-common`
 `orgmanax-server`| 业务层，核心分为两层：<br/>1、基础业务层:`foundation`<br/>2、业务层：`biz`  <br/>`foundation`依赖`biz`完成业务编排 |  `orgmanax-api` `orgmanax-common` `orgmanax-infra` 
 
+
+## 各模块参数约束
+![img_1.png](img_1.png)
+- REQ：请求入参
+- RESP：请求出参
+- XXXQuery：基础功能入参
+- XXXCreate：
+- XXXUpdate：更新入参
+- DO：数据库实体，DO使用充血模型，包括属性和行为，定义行为的范围：只能是本对象内部属性发生变更的行为
+
+## 接口层级
+![img.png](img.png)
+
+
 ## 目录层级
 ```
 .
@@ -78,7 +91,7 @@
 │       │   │                       └── node #部门相关
 │       │   │                           ├── convert #数据转换相关，比如将entity转换为数据实体do
 │       │   │                           ├── dao #mybatisplus的service实现，用于CRUD，可与Lambda表达式配合使用。
-│       │   │                           ├── DO #数据实体
+│       │   │                           ├── DO #数据实体 包含实体的属性及行为
 │       │   │                           ├── repos # 业务查询防腐层，提供给service层使用，用于隔离service层与dao层
 │       │   │                           │   └── impl #gateway的具体实现可以调用dao完成相关功能，也可以作为聚合根获取数据的实现
 │       │   │                           └── mapper