用户认证接口
<p>[TOC]</p>
<h5>简要描述</h5>
<ul>
<li>用户认证接口</li>
</ul>
<h5>请求URL</h5>
<ul>
<li><code>/api/auth/{type}</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;">Authorization</td>
<td style="text-align: left;">是</td>
<td style="text-align: left;">string</td>
<td>JWT</td>
</tr>
</tbody>
</table>
<h5>REST 参数</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;">type</td>
<td style="text-align: left;">是</td>
<td style="text-align: left;">string</td>
<td>类型</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;">keyword</td>
<td style="text-align: left;">是</td>
<td style="text-align: left;">string</td>
<td>关键字</td>
</tr>
</tbody>
</table>
<h5>BODY 参数</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;">email</td>
<td style="text-align: left;">是</td>
<td style="text-align: left;">string</td>
<td>邮箱</td>
</tr>
</tbody>
</table>
<h5>正确的返回示例</h5>
<pre><code> {
"status_code": 200,
"data": {
"name": "昵称",
"email": "邮箱",
}
}</code></pre>
<h5>错误的返回示例</h5>
<pre><code> {
"status_code": 422,
"errors": {
"name": [
"昵称不能为空",
],
"email": [
"邮箱不能为空",
],
"password": [
"密码不能为空",
],
}
}</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;">name</td>
<td style="text-align: left;">string</td>
<td>昵称</td>
</tr>
<tr>
<td style="text-align: left;">email</td>
<td style="text-align: left;">string</td>
<td>邮箱</td>
</tr>
</tbody>
</table>
<h5>备注</h5>
<ul>
<li>更多返回错误代码请看首页的错误代码描述</li>
</ul>