DormController
<h5>简要描述</h5>
<ul>
<li>宿舍信息接口</li>
</ul>
<h5>请求URL</h5>
<ul>
<li><code>http://localhost:8080/api/dorm/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":"M2317",
"buildingId":260,
"maxNum":4,
"remark":null,
"building":{
"id":260,
"name":"清枫阁",
"buildingType":null,
"remark":null
}
},
{
"id":261,
"name":"G239",
"buildingId":263,
"maxNum":4,
"remark":null,
"building":{
"id":263,
"name":"绿杨楼",
"buildingType":null,
"remark":null
}
},
{
"id":263,
"name":"K212",
"buildingId":267,
"maxNum":4,
"remark":null,
"building":{
"id":267,
"name":"金桂园",
"buildingType":null,
"remark":null
}
},
{
"id":267,
"name":"G7105",
"buildingId":270,
"maxNum":6,
"remark":"",
"building":{
"id":270,
"name":"书院楼",
"buildingType":null,
"remark":null
}
}
],
"total":4
}</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>宿舍id</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;">buildingId</td>
<td style="text-align: left;">int</td>
<td>宿舍楼id</td>
</tr>
<tr>
<td style="text-align: left;">maxNum</td>
<td style="text-align: left;">int</td>
<td>最大人数</td>
</tr>
<tr>
<td style="text-align: left;">remark</td>
<td style="text-align: left;">String</td>
<td>备注</td>
</tr>
<tr>
<td style="text-align: left;">building</td>
<td style="text-align: left;">building</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/dorm/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;">buildingId</td>
<td style="text-align: left;">是</td>
<td style="text-align: left;">int</td>
<td>宿舍楼Id</td>
</tr>
<tr>
<td style="text-align: left;">maxNum</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/dorm/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;">dorms</td>
<td style="text-align: left;">是</td>
<td style="text-align: left;">List<Dorm></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>