diff --git a/README.md b/README.md index 52e66616f15aca91133e7663395921705201f5f2..eda255c749f2dd3be8c903cd7b13e6337790d886 100644 --- a/README.md +++ b/README.md @@ -6,30 +6,45 @@ #### 项目结构 -> /webapp * 前端工程目录 -> /backend +> /webapp + * 后端工程目录 -> /README.md +> /backend + * 工程说明 +> /README.md + +* 工程文档目录 + +> /docs + + + ### 工程架构说明 #### 后端架构 1. DAO + > 负责与数据库交互等 2. Controller > 提供Http Api接口,与前端Ajax对接 * Servlet + > Servlet写到这个包里 * Filter + > 请求过滤,负责权限验证,编码修改等 3. Service + > 业务逻辑,负责DAO层与Controller层的逻辑交互 4. Util + > 工具包,将常用代码封装,提高代码复用性 5. Bean + > Java数据对象 #### 软件架构 软件架构说明 diff --git a/Test/prtest b/Test/prtest new file mode 100644 index 0000000000000000000000000000000000000000..e69de29bb2d1d6434b8b29ae775ad8c2e48c5391 diff --git a/docs/.keep b/docs/.keep new file mode 100644 index 0000000000000000000000000000000000000000..e69de29bb2d1d6434b8b29ae775ad8c2e48c5391 diff --git "a/docs/apis/\346\216\245\345\217\243\346\226\207\346\241\243\347\244\272\344\276\213.md" "b/docs/apis/\346\216\245\345\217\243\346\226\207\346\241\243\347\244\272\344\276\213.md" new file mode 100644 index 0000000000000000000000000000000000000000..9bf3cc0536480225364f6f37eb846cdf69e5e6f8 --- /dev/null +++ "b/docs/apis/\346\216\245\345\217\243\346\226\207\346\241\243\347\244\272\344\276\213.md" @@ -0,0 +1,26 @@ +## 接口中文名 + +### 接口描述 + +这里写接口的描述,用途等 + +### 接口属性 + +* 接口路径: +* 接口说明: +* 返回格式: +* 请求方式: +* 请求示例: + +### 请求参数 + +| 名称 | 类型 | 是否必填 | 说明 | +| ---- | ---- | -------- | ---- | +| | | | | + +### 返回参数 + +| 名称 | 类型 | 说明 | +| ---- | ---- | ---- | +| | | | +