|
@@ -75,67 +75,94 @@
|
|
|
<div class=""></div>
|
|
|
<!-- 模板存放的地方 -->
|
|
|
<div id="api-doc-templ" ref="api_doc_templ" style="display:none">
|
|
|
-
|
|
|
-**简要描述:**
|
|
|
|
|
|
-- 用户注册接口
|
|
|
+ **名称:**
|
|
|
+
|
|
|
+ - 用户注册
|
|
|
+
|
|
|
+ **描述:**
|
|
|
+
|
|
|
+ - 无
|
|
|
+
|
|
|
+ **请求地址(URL):**
|
|
|
+ - ` http://xx.com/api/user/register `
|
|
|
+
|
|
|
+ **请求方式:**
|
|
|
+ - GET
|
|
|
+ - POST
|
|
|
|
|
|
-**请求URL:**
|
|
|
-- ` http://xx.com/api/user/register `
|
|
|
-
|
|
|
-**请求方式:**
|
|
|
-- POST
|
|
|
+ **请求参数:**
|
|
|
|
|
|
-**参数:**
|
|
|
+ |参数名|必填|类型|说明|
|
|
|
+ |:---- |:---|:----- |----- |
|
|
|
+ |username |是 |string |用户名 |
|
|
|
+ |password |是 |string | 密码 |
|
|
|
+ |name |否 |string | 昵称 |
|
|
|
|
|
|
-|参数名|必选|类型|说明|
|
|
|
-|:---- |:---|:----- |----- |
|
|
|
-|username |是 |string |用户名 |
|
|
|
-|password |是 |string | 密码 |
|
|
|
-|name |否 |string | 昵称 |
|
|
|
+ **响应参数:**
|
|
|
|
|
|
- **返回示例**
|
|
|
+ |参数名|父元素|类型|说明|
|
|
|
+ |:-----|:-----|:-----|:-----|
|
|
|
+ | uid | data | int | 用户ID |
|
|
|
+ | name | data | string | 用户姓名 |
|
|
|
+ | avatar | data | object | 用户头像 |
|
|
|
+ | url | avatar | string | 头像地址 |
|
|
|
+ | width | avatar | int | 头像图片宽度 |
|
|
|
+ | height | avatar | int | 头像图片高度 |
|
|
|
|
|
|
-```
|
|
|
+ **响应示例:**
|
|
|
+
|
|
|
+ - 成功
|
|
|
+
|
|
|
+ ```
|
|
|
{
|
|
|
- "error_code": 0,
|
|
|
+ "code": 0,
|
|
|
+ "msg": "",
|
|
|
"data": {
|
|
|
- "uid": "1",
|
|
|
- "username": "12154545",
|
|
|
- "name": "吴系挂",
|
|
|
- "groupid": 2 ,
|
|
|
+ "uid": 1,
|
|
|
+ "username": "123456",
|
|
|
+ "name": "张三",
|
|
|
"reg_time": "1436864169",
|
|
|
"last_login_time": "0",
|
|
|
+ "avatar":{
|
|
|
+ "url": "http://xx.com/avatar/default.png",
|
|
|
+ "width": 300,
|
|
|
+ "height": 300
|
|
|
+ }
|
|
|
}
|
|
|
}
|
|
|
-```
|
|
|
+ ```
|
|
|
+
|
|
|
+ - 失败
|
|
|
|
|
|
- **返回参数说明**
|
|
|
+ ```
|
|
|
+ {
|
|
|
+ "code": 1,
|
|
|
+ "msg": "用户名必须是手机号码"
|
|
|
+ }
|
|
|
+ ```
|
|
|
|
|
|
-|参数名|类型|说明|
|
|
|
-|:----- |:-----|----- |
|
|
|
-|groupid |int |用户组id,1:超级管理员;2:普通用户 |
|
|
|
+ **备注**
|
|
|
|
|
|
- **备注**
|
|
|
+ - 更多返回错误代码请看错误代码描述页面
|
|
|
|
|
|
-- 更多返回错误代码请看首页的错误代码描述
|
|
|
|
|
|
|
|
|
</div>
|
|
|
<div id="database-doc-templ" ref="database_doc_templ" style="display:none">
|
|
|
-
|
|
|
-- 用户表,储存用户信息
|
|
|
|
|
|
-|字段|类型|空|默认|注释|
|
|
|
-|:---- |:------- |:--- |-- -|------ |
|
|
|
-|uid |int(10) |否 | | |
|
|
|
-|username |varchar(20) |否 | | 用户名 |
|
|
|
-|password |varchar(50) |否 | | 密码 |
|
|
|
-|name |varchar(15) |是 | | 昵称 |
|
|
|
-|reg_time |int(11) |否 | 0 | 注册时间 |
|
|
|
+ #### 用户表
|
|
|
+ - 储存用户信息
|
|
|
|
|
|
-- 备注:无
|
|
|
+ |字段|类型|空|默认|额外|注释|
|
|
|
+ |:------|:-------|:-----|:-----|:------|:------|
|
|
|
+ |uid |int(10) |否 | 无 | 主键、自增|用户ID |
|
|
|
+ |username |varchar(20) |否 | 无 | | 用户名 |
|
|
|
+ |password |varchar(50) |否 | 无 | | 密码 |
|
|
|
+ |name |varchar(15) |是 | NULL | | 昵称 |
|
|
|
+ |reg_time |datetime |否 |无 | | 注册时间 |
|
|
|
|
|
|
+ - 备注:无
|
|
|
|
|
|
</div>
|
|
|
|
|
@@ -330,6 +357,7 @@ export default {
|
|
|
|
|
|
ShowRunApi(){
|
|
|
// window.open('http://runapi.showdoc.cc/');
|
|
|
+ window.open('https://www.sojson.com/httpRequest/');
|
|
|
},
|
|
|
//更多模板、模板列表
|
|
|
ShowTemplateList(){
|