用户列表
<h5>接口描述</h5>
<ul>
<li><code>用户列表</code></li>
</ul>
<h5>请求URL</h5>
<ul>
<li><code>http://heapi.vipgz4.91tunnel.com/api/admin/users</code></li>
</ul>
<h5>请求方式</h5>
<ul>
<li><code>GET</code></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;">Authorization</td>
<td style="text-align: left;">是</td>
<td style="text-align: left;">string</td>
<td>JWT token</td>
</tr>
</tbody>
</table>
<h5>Query 请求参数<code>【一般用于 GET 请求查询，以 ? 的形式附加到 URL】</code></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;">name</td>
<td style="text-align: left;">否</td>
<td style="text-align: left;">string</td>
<td>用户名</td>
</tr>
<tr>
<td style="text-align: left;">email</td>
<td style="text-align: left;">否</td>
<td style="text-align: left;">email</td>
<td>邮箱</td>
</tr>
</tbody>
</table>
<h5>返回示例</h5>
<ul>
<li>
<p>状态码 200 请求成功</p>
<pre><code>{
"data": [
{
"id": 1,
"name": "a",
"email": "a@a.com",
"is_locked": 1,
"created_at": null,
"updated_at": null
},
{
"id": 2,
"name": "b",
"email": "b@b.com",
"is_locked": 0,
"created_at": null,
"updated_at": null
}
],
"meta": {
"pagination": {
"total": 22,
"count": 2,
"per_page": 2,
"current_page": 1,
"total_pages": 11,
"links": {
"next": "http://api.cc/api/admin/users?page=2"
}
}
}</code></pre>
</li>
<li>状态码 401 认证未通过<code>token过期</code> <code>被加入黑名单``未添加token进行验证</code>
<pre><code>{
"message": "Token has expired",
"status_code": 401,
}</code></pre></li>
</ul>
<h5>备注</h5>
<ul>
<li><code>查询</code></li>
</ul>
<table>
<thead>
<tr>
<th style="text-align: left;">参数名</th>
<th style="text-align: left;">查询说明</th>
</tr>
</thead>
<tbody>
<tr>
<td style="text-align: left;">name</td>
<td style="text-align: left;">模糊搜索 <code>%name%</code></td>
</tr>
<tr>
<td style="text-align: left;">email</td>
<td style="text-align: left;">完整查询 <code>email</code></td>
</tr>
</tbody>
</table>
<ul>
<li><code>分页</code></li>
</ul>
<pre><code> 每一页最多显示两条数据</code></pre>