接口测试文档

Love The Way You Lie 2023-10-14 08:32 10阅读 0赞

## 个人项目 ##

> v1.0.0

Base URLs:

*  [本地测试: http://localhost:8081/ssm][http_localhost_8081_ssm]

## 测试写接口文档 ##

### POST 用户登录 ###

POST /user/userLogin

#### 请求参数 ####

<table> 
 <thead> 
  <tr> 
   <th>名称</th> 
   <th>位置</th> 
   <th>类型</th> 
   <th>必选</th> 
   <th>说明</th> 
  </tr> 
 </thead> 
 <tbody> 
  <tr> 
   <td>username</td> 
   <td>query</td> 
   <td>string</td> 
   <td>否</td> 
   <td>用户</td> 
  </tr> 
  <tr> 
   <td>password</td> 
   <td>query</td> 
   <td>string</td> 
   <td>否</td> 
   <td>密码</td> 
  </tr> 
 </tbody> 
</table>

> 返回示例

> 成功

{
        
      "msg": "用户登陆成功！",
      "success": true,
      "total": 0,
      "rows": null
    }

#### 返回结果 ####

<table> 
 <thead> 
  <tr> 
   <th>状态码</th> 
   <th>状态码含义</th> 
   <th>说明</th> 
   <th>数据模型</th> 
  </tr> 
 </thead> 
 <tbody> 
  <tr> 
   <td>200</td> 
   <td><a href="https://tools.ietf.org/html/rfc7231#section-6.3.1" rel="nofollow">OK</a></td> 
   <td>成功</td> 
   <td>Inline</td> 
  </tr> 
 </tbody> 
</table>

#### 返回数据结构 ####

状态码 **200**

<table> 
 <thead> 
  <tr> 
   <th>名称</th> 
   <th>类型</th> 
   <th>必选</th> 
   <th>约束</th> 
   <th>中文名</th> 
   <th>说明</th> 
  </tr> 
 </thead> 
 <tbody> 
  <tr> 
   <td>» msg</td> 
   <td>string</td> 
   <td>true</td> 
   <td>none</td> 
   <td></td> 
   <td>none</td> 
  </tr> 
  <tr> 
   <td>» success</td> 
   <td>boolean</td> 
   <td>true</td> 
   <td>none</td> 
   <td></td> 
   <td>none</td> 
  </tr> 
  <tr> 
   <td>» total</td> 
   <td>integer</td> 
   <td>true</td> 
   <td>none</td> 
   <td></td> 
   <td>none</td> 
  </tr> 
  <tr> 
   <td>» rows</td> 
   <td>null</td> 
   <td>true</td> 
   <td>none</td> 
   <td></td> 
   <td>none</td> 
  </tr> 
 </tbody> 
</table>

### POST 用户注册 ###

POST /user/userRegister

#### 请求参数 ####

<table> 
 <thead> 
  <tr> 
   <th>名称</th> 
   <th>位置</th> 
   <th>类型</th> 
   <th>必选</th> 
   <th>说明</th> 
  </tr> 
 </thead> 
 <tbody> 
  <tr> 
   <td>username</td> 
   <td>query</td> 
   <td>string</td> 
   <td>否</td> 
   <td>用户名</td> 
  </tr> 
  <tr> 
   <td>password</td> 
   <td>query</td> 
   <td>string</td> 
   <td>否</td> 
   <td>密码</td> 
  </tr> 
 </tbody> 
</table>

> 返回示例

> 成功

{
        
      "msg": "用户注册成功！",
      "success": true,
      "total": 0,
      "rows": null
    }

#### 返回结果 ####

#### 返回数据结构 ####

状态码 **200**

## 数据模型 ##

[http_localhost_8081_ssm]: http://localhost:8081/ssm