接口实例说明
<p>[TOC]</p>
<h5>简要描述</h5>
<ul>
<li>接口实例说明</li>
</ul>
<h5>请求URL</h5>
<ul>
<li><code>/api/*</code></li>
</ul>
<h5>请求方式</h5>
<ul>
<li>POST | GET | PUT | DELETE </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;">*</td>
<td style="text-align: left;">是</td>
<td style="text-align: left;">string、int、bool</td>
<td>*</td>
</tr>
</tbody>
</table>
<h5>返回成功示例</h5>
<pre><code>{
"code": 200,
"data": [],
"message": "成功！"
}</code></pre>
<h5>返回失败示例</h5>
<pre><code>{
"code": 201,
"data": [],
"message": "失败！"
}</code></pre>
<h5>返回登录失败示例</h5>
<pre><code>{
"code": 202,
"data": [],
"message": "验证失败, token无效"
}</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;">code</td>
<td style="text-align: left;">int</td>
<td>返回状态码， 200：成功 201：失败，202：登录失效，需跳转登录页</td>
</tr>
<tr>
<td style="text-align: left;">data</td>
<td style="text-align: left;">int、string、array</td>
<td>返回数据结构</td>
</tr>
<tr>
<td style="text-align: left;">message</td>
<td style="text-align: left;">string</td>
<td>提示信息或默认信息</td>
</tr>
</tbody>
</table>
<h5>备注</h5>
<ul>
<li>更多返回错误代码请看首页的错误代码描述</li>
</ul>