古诗词列表展示
<p>[TOC]</p>
<h5>简要描述</h5>
<p>古诗词列表展示接口</p>
<h5>请求URL</h5>
<p><a href="http://localhost:222/list">http://localhost:222/list</a></p>
<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;">username</td>
<td style="text-align: left;">是</td>
<td style="text-align: left;">string</td>
<td>用户名</td>
</tr>
<tr>
<td style="text-align: left;">password</td>
<td style="text-align: left;">是</td>
<td style="text-align: left;">string</td>
<td>密码</td>
</tr>
<tr>
<td style="text-align: left;">name</td>
<td style="text-align: left;">否</td>
<td style="text-align: left;">string</td>
<td>昵称</td>
</tr>
</tbody>
</table>
<h5>返回示例</h5>
<pre><code> {
"code": "00000",
"msg": "成功",
"data": [
{
"_id": "62aec3f32161fbbacdfffd71",
"username": "咏鹅",
"type": "诗",
"content": "白毛浮绿水,红掌拨清波",
"author": "李白",
"__v": 0
},
{
"_id": "62aec86f2161fbbacdfffd75",
"username": "小白兔",
"type": "歌",
"content": "小白兔,白又白,两只耳朵竖起来",
"author": "兔子丫",
"__v": 0
}
]</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>反回状态码“00000”表示成功</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;">data</td>
<td style="text-align: left;">string</td>
<td>数据</td>
</tr>
</tbody>
</table>
<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;">00001</td>
<td style="text-align: left;">int</td>
<td>缺少token</td>
</tr>
<tr>
<td style="text-align: left;">00002</td>
<td style="text-align: left;">int</td>
<td>token不合法或者无效</td>
</tr>
<tr>
<td style="text-align: left;">00003</td>
<td style="text-align: left;">int</td>
<td>签名无效</td>
</tr>
<tr>
<td style="text-align: left;">00004</td>
<td style="text-align: left;">int</td>
<td>token时间大于当前时间,不合法</td>
</tr>
<tr>
<td style="text-align: left;">00005</td>
<td style="text-align: left;">int</td>
<td>token签名时间过期</td>
</tr>
<tr>
<td style="text-align: left;">00006</td>
<td style="text-align: left;">int</td>
<td>该时间之前不接受处理该token</td>
</tr>
<tr>
<td style="text-align: left;">00007</td>
<td style="text-align: left;">int</td>
<td>唯一标识出错</td>
</tr>
</tbody>
</table>