master

分支 (1)

管理

管理

master

King-warehouse
/
文档示例陈泽帅.doc


        <html xmlns:v="urn:schemas-microsoft-com:vml"
        xmlns:o="urn:schemas-microsoft-com:office:office"
        xmlns:w="urn:schemas-microsoft-com:office:word"
        xmlns="http://www.w3.org/TR/REC-html40">
        <head><meta http-equiv=Content-Type content="text/html;
        charset=utf-8">
        <style type="text/css">
            table
            {
                border-collapse: collapse;
                border: none;
                width: 100%;
            }
            td
            {
                border: solid #CCC 1px;
            }
            .codestyle{
                word-break: break-all;
                background:silver;mso-highlight:silver;
            }
        </style>
        <meta name=ProgId content=Word.Document>
        <meta name=Generator content="Microsoft Word 11">
        <meta name=Originator content="Microsoft Word 11">
        <xml><w:WordDocument><w:View>Print</w:View></xml></head>
        <body><h1>1、公文系统</h1><div style="margin-left:20px;"><h1>背景说明</h1>
<p>公文系统用户的登录注册信息状态</p></div><h1>2、接口协议</h1><div style="margin-left:20px;"><h2>1.用户信息</h2>
<h3>1.1用户注册</h3>
<p><strong>参数:</strong></p>
<table>
<thead><tr style='background-color: rgb(0, 136, 204); color: rgb(255, 255, 255);'>
<th>参数名</th>
<th>类型</th>
<th>必填</th>
<th>描述</th>
<th>默认值</th>
<th>参考值</th>
</tr>
</thead>
<tbody>
<tr>
<td>username</td>
<td>str</td>
<td>必填</td>
<td>用户名</td>
<td>-</td>
<td>-</td>
</tr>
<tr>
<td>password</td>
<td>str</td>
<td>必填</td>
<td>密码</td>
<td>-</td>
<td>-</td>
</tr>
<tr>
<td>confirm_password</td>
<td>str</td>
<td>必填</td>
<td>确认密码</td>
<td>-</td>
<td>-</td>
</tr>
<tr>
<td>Email</td>
<td>str</td>
<td>必填</td>
<td>邮箱</td>
<td>-</td>
<td>-</td>
</tr>
<tr>
<td>code</td>
<td>str</td>
<td>必填</td>
<td>验证码</td>
<td>-</td>
<td>-</td>
</tr>
<tr>
<td>img</td>
<td>str</td>
<td>可选</td>
<td>头像上传</td>
<td>-</td>
<td>-</td>
</tr>
</tbody>
</table>
<p><strong>请求方法: POST</strong></p>
<p><strong>返回值</strong></p>
<pre><code class="language-python">成功状态
{
    "result":{
        "code":200,
        "msg":"success"
    },
    "data":{
        "username":"用户名"
    }
}</code></pre></table>
<pre><code class="language-python">失败状态

{
    "result":{
        "code":400,
        "msg":{
            "error_code":4001,
            "error_msg":"该用户已存在",
            "error_code":4002,
            "error_msg":"注册格式有误",
            "error_code":4003,
            "error_msg":"邮箱输入有误",
            "error_code":4004,
            "error_msg":"验证码有误",
            "error_code":4005,
            "error_msg":"两次密码不一致",
        }
    }
}</code></pre></table>
<h3>1.2 用户登录</h3>
<table>
<thead><tr style='background-color: rgb(0, 136, 204); color: rgb(255, 255, 255);'>
<th>参数名</th>
<th>类型</th>
<th>必填</th>
<th>描述</th>
<th>默认值</th>
<th>参考值</th>
</tr>
</thead>
<tbody>
<tr>
<td>username</td>
<td>str</td>
<td>必填</td>
<td>用户名</td>
<td>-</td>
<td>-</td>
</tr>
<tr>
<td>password</td>
<td>str</td>
<td>必填</td>
<td>密码</td>
<td>-</td>
<td>-</td>
</tr>
</tbody>
</table>
<p><strong>请求方法:POST</strong></p>
<p><strong>返回值</strong></p>
<pre><code class="language-python">成功状态
{
    "result":{
        "code":200,
        "msg":"登录成功",
    }
    "data":{
        "username":"用户名",
        "password":"密码"
    }
}</code></pre></table>
<pre><code class="language-python">失败状态
{
    "result":{
        "code":400,
        "msg":"用户名或密码错误!"
    }
}</code></pre></table></div></body></html>