用户列表
<h5>接口描述</h5>
<ul>
<li>用户列表</li>
</ul>
<h5>请求URL</h5>
<ul>
<li><code>/api/admin/users</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;">Authorization</td>
<td style="text-align: left;">是</td>
<td style="text-align: left;">string</td>
<td>JWT token</td>
</tr>
</tbody>
</table>
<h5>Query 请求参数</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;">current</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;">string</td>
<td>邮箱匹配搜索</td>
</tr>
<tr>
<td style="text-align: left;">phone</td>
<td style="text-align: left;">否</td>
<td style="text-align: left;">string</td>
<td>手机号匹配搜索</td>
</tr>
</tbody>
</table>
<h5>返回参数</h5>
<p><strong>data</strong></p>
<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;">id</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;">string</td>
<td>邮箱</td>
</tr>
<tr>
<td style="text-align: left;">phone</td>
<td style="text-align: left;">是</td>
<td style="text-align: left;">string</td>
<td>手机号</td>
</tr>
<tr>
<td style="text-align: left;">avatar</td>
<td style="text-align: left;">是</td>
<td style="text-align: left;">string</td>
<td>头像</td>
</tr>
<tr>
<td style="text-align: left;">avatar_url</td>
<td style="text-align: left;">是</td>
<td style="text-align: left;">string</td>
<td>头像地址</td>
</tr>
<tr>
<td style="text-align: left;">is_locked</td>
<td style="text-align: left;">是</td>
<td style="text-align: left;">int</td>
<td>是否锁定： 0正常 1锁定</td>
</tr>
<tr>
<td style="text-align: left;">created_at</td>
<td style="text-align: left;">是</td>
<td style="text-align: left;">timestamp</td>
<td>创建时间</td>
</tr>
<tr>
<td style="text-align: left;">updated_at</td>
<td style="text-align: left;">是</td>
<td style="text-align: left;">timestamp</td>
<td>更新时间</td>
</tr>
</tbody>
</table>
<p><strong>meta.pagination</strong></p>
<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;">total</td>
<td style="text-align: left;">是</td>
<td style="text-align: left;">int</td>
<td>数据总数</td>
</tr>
<tr>
<td style="text-align: left;">count</td>
<td style="text-align: left;">是</td>
<td style="text-align: left;">int</td>
<td>当前页数据</td>
</tr>
<tr>
<td style="text-align: left;">per_page</td>
<td style="text-align: left;">是</td>
<td style="text-align: left;">int</td>
<td>每页显示条数</td>
</tr>
<tr>
<td style="text-align: left;">current_page</td>
<td style="text-align: left;">是</td>
<td style="text-align: left;">int</td>
<td>当前页页码</td>
</tr>
<tr>
<td style="text-align: left;">total_pages</td>
<td style="text-align: left;">是</td>
<td style="text-align: left;">int</td>
<td>总页数</td>
</tr>
<tr>
<td style="text-align: left;">links.previous</td>
<td style="text-align: left;">是</td>
<td style="text-align: left;">string</td>
<td>上一页链接</td>
</tr>
<tr>
<td style="text-align: left;">links.next</td>
<td style="text-align: left;">是</td>
<td style="text-align: left;">string</td>
<td>下一页链接</td>
</tr>
</tbody>
</table>
<h5>返回示例</h5>
<ul>
<li>状态码 200 请求成功</li>
</ul>
<pre><code>{
"data": [
{
"id": 1,
"name": "超级管理员",
"email": "super@a.com",
"phone": null,
"avatar": null,
"avatar_url": "",
"is_locked": 1,
"created_at": "2020-12-22T02:58:08.000000Z",
"updated_at": "2020-12-24T06:40:44.000000Z"
},
{
"id": 2,
"name": "xx",
"email": "12311@qq.com",
"phone": null,
"avatar": null,
"avatar_url": "",
"is_locked": 0,
"created_at": "2020-12-24T03:47:48.000000Z",
"updated_at": "2020-12-24T06:44:43.000000Z"
}
],
"meta": {
"pagination": {
"total": 7,
"count": 2,
"per_page": 2,
"current_page": 1,
"total_pages": 4,
"links": {
"previous": null,
"next": "http://shopapi.mamp/api/admin/users?page=2"
}
}
}
}</code></pre>