teachingSystem

教学辅助系统


登录

<p>[TOC]</p> <h5>简要描述</h5> <ul> <li>用户登录接口</li> </ul> <h5>请求URL</h5> <ul> <li><code>/admin/auth/login</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;">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> </tbody> </table> <h5>返回示例</h5> <p>成功:</p> <pre><code> { &amp;quot;code&amp;quot;: 200, &amp;quot;data&amp;quot;:{ &amp;quot;username&amp;quot;:&amp;quot;admin&amp;quot;, &amp;quot;token&amp;quot;:&amp;quot;dcabafasbasdbasd&amp;quot;, &amp;quot;time&amp;quot;:&amp;quot;2023-5-23 20:23&amp;quot; }, &amp;quot;message&amp;quot;:&amp;quot;登陆成功&amp;quot; }</code></pre> <p>失败:</p> <pre><code> { &amp;quot;code&amp;quot;: 201, &amp;quot;data&amp;quot;:{}, &amp;quot;message&amp;quot;:&amp;quot;登陆失败,未知原因&amp;quot; }</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为请求成功</td> </tr> <tr> <td style="text-align: left;">data</td> <td style="text-align: left;">object</td> <td>返回请求携带的数据</td> </tr> <tr> <td style="text-align: left;">token</td> <td style="text-align: left;">是</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> <p>token用于安全认证,前端发每一个请求必须以请求体的形式携带自己的token给后端进行验证,如没有token则说明无权操作(可用拦截器实现)</p> </li> <li>防止恶意攻击</li> </ul>

页面列表

ITEM_HTML