Java web开发项目设计


BuildingController

<h5>简要描述</h5> <ul> <li>获取宿舍楼信息</li> </ul> <h5>请求URL</h5> <ul> <li><code>http://localhost:8080/api/building/list</code></li> </ul> <h5>请求方式</h5> <ul> <li>GET </li> </ul> <h5>参数</h5> <table> <thead> <tr> <th style="text-align: left;">参数名</th> <th style="text-align: left;">必选</th> <th style="text-align: left;">类型</th> <th>说明</th> </tr> </thead> <tbody> <tr> <td style="text-align: left;">page</td> <td style="text-align: left;">是</td> <td style="text-align: left;">int</td> <td>第一页</td> </tr> <tr> <td style="text-align: left;">size</td> <td style="text-align: left;">是</td> <td style="text-align: left;">int</td> <td>大小</td> </tr> </tbody> </table> <h5>返回示例</h5> <pre><code>{     "data":[         {             "id":260,             "name":"清枫阁",             "buildingType":1,             "remark":"M"         },         {             "id":261,             "name":"红棉楼",             "buildingType":1,             "remark":"R"         },         {             "id":262,             "name":"黄槐楼",             "buildingType":1,             "remark":"Y"         },         {             "id":263,             "name":"绿杨楼",             "buildingType":1,             "remark":"G\\P"         },         {             "id":264,             "name":"书新楼",             "buildingType":1,             "remark":"Q"         }     ],     "total":11 }</code></pre> <h5>返回参数说明</h5> <table> <thead> <tr> <th style="text-align: left;">参数名</th> <th style="text-align: left;">类型</th> <th>说明</th> </tr> </thead> <tbody> <tr> <td style="text-align: left;">id</td> <td style="text-align: left;">int</td> <td>宿舍楼号</td> </tr> <tr> <td style="text-align: left;">name</td> <td style="text-align: left;">String</td> <td>宿舍楼名</td> </tr> <tr> <td style="text-align: left;">buildingType</td> <td style="text-align: left;">int</td> <td>宿舍楼类型,1:男生宿舍楼 0:女生宿舍楼</td> </tr> <tr> <td style="text-align: left;">remark</td> <td style="text-align: left;">String</td> <td>备注</td> </tr> </tbody> </table> <h5>备注</h5> <ul> <li>更多返回错误代码请看首页的错误代码描述</li> </ul> <hr /> <h5>简要描述</h5> <ul> <li>增添修改宿舍楼接口</li> </ul> <h5>请求URL</h5> <ul> <li><code>http://localhost:8080/api/building/add</code></li> </ul> <h5>请求方式</h5> <ul> <li>POST</li> </ul> <h5>参数</h5> <table> <thead> <tr> <th style="text-align: left;">参数名</th> <th style="text-align: left;">必选</th> <th style="text-align: left;">类型</th> <th>说明</th> </tr> </thead> <tbody> <tr> <td style="text-align: left;">name</td> <td style="text-align: left;">是</td> <td style="text-align: left;">String</td> <td>宿舍楼名</td> </tr> <tr> <td style="text-align: left;">buildingType</td> <td style="text-align: left;">是</td> <td style="text-align: left;">int</td> <td>宿舍类型</td> </tr> <tr> <td style="text-align: left;">remark</td> <td style="text-align: left;">是</td> <td style="text-align: left;">String</td> <td>备注</td> </tr> </tbody> </table> <h5>返回示例</h5> <pre><code>{     "status":200,     "msg":"添加成功!",     "obj":null }</code></pre> <h5>返回参数说明</h5> <table> <thead> <tr> <th style="text-align: left;">参数名</th> <th style="text-align: left;">类型</th> <th>说明</th> </tr> </thead> <tbody> <tr> <td style="text-align: left;">status</td> <td style="text-align: left;">int</td> <td>状态码</td> </tr> <tr> <td style="text-align: left;">msg</td> <td style="text-align: left;">String</td> <td>运行结果,成功时显示添加成功或修改成功,失败时显示添加失败或修改失败</td> </tr> <tr> <td style="text-align: left;">obj</td> <td style="text-align: left;">Object</td> <td>对象</td> </tr> </tbody> </table> <h5>备注</h5> <ul> <li>更多返回错误代码请看首页的错误代码描述</li> </ul> <hr /> <h5>简要描述</h5> <ul> <li>宿舍楼信息删除接口</li> </ul> <h5>请求URL</h5> <ul> <li><code>http://localhost:8080/api/building/del</code></li> </ul> <h5>请求方式</h5> <ul> <li>POST </li> </ul> <h5>参数</h5> <table> <thead> <tr> <th style="text-align: left;">参数名</th> <th style="text-align: left;">必选</th> <th style="text-align: left;">类型</th> <th>说明</th> </tr> </thead> <tbody> <tr> <td style="text-align: left;">buildings</td> <td style="text-align: left;">是</td> <td style="text-align: left;">List<Building></td> <td>存储宿舍楼信息的集合</td> </tr> </tbody> </table> <h5>返回示例</h5> <pre><code>{     "status":200,     "msg":"删除成功!",     "obj":null }</code></pre> <h5>返回参数说明</h5> <table> <thead> <tr> <th style="text-align: left;">参数名</th> <th style="text-align: left;">类型</th> <th>说明</th> </tr> </thead> <tbody> <tr> <td style="text-align: left;">status</td> <td style="text-align: left;">int</td> <td>状态码</td> </tr> <tr> <td style="text-align: left;">msg</td> <td style="text-align: left;">String</td> <td>运行结果,成功时显示删除成功,失败时显示删除失败</td> </tr> <tr> <td style="text-align: left;">obj</td> <td style="text-align: left;">Object</td> <td>对象</td> </tr> </tbody> </table> <h5>备注</h5> <ul> <li>若输入的姓名查找不到不存在,将会显示暂无数据!</li> </ul>

页面列表

ITEM_HTML