加入目录

Readme.md

@@ -22,7 +22,7 @@ Java + spring cloud + mybatis + mysql + kafka + redis
 
 ### 如何开始（how to start）
 
-[从这里开始](docs/Readme.md)
+[从这里开始](http://www.java110.com/MicroCommunity)
 
 ### 如何安装（how to install）
 

docs/_sidebar.md

@@ -23,6 +23,8 @@
 * api接口
 
   * [用户注册](api/user/register)
+  * [用户登录](api/user/login)
+  * [用户校验登录](api/user/checkLogin)
 
 * 工具类接口
 

docs/api/user/checkLogin.md

@@ -0,0 +1,58 @@
+
+
+**1\. 用户校验登录**
+###### 接口功能
+> 用户通过web端或APP校验是否登录系统
+
+###### URL
+> [http://api.java110.com:8008/api/check.service.login](http://api.java110.com:8008/api/check.service.login)
+
+###### 支持格式
+> JSON
+
+###### HTTP请求方式
+> POST
+
+###### 请求参数(header部分)
+|参数名称|约束|类型|长度|描述|取值说明|
+| :-: | :-: | :-: | :-: | :-: | :-:|
+|app_id|1|String|30|应用ID|Api服务分配                      |
+|transaction_id|1|String|30|请求流水号|不能重复 1000000000+YYYYMMDDhhmmss+6位序列 |
+|sign|1|String|-|签名|请参考签名说明|
+|req_time|1|String|-|请求时间|YYYYMMDDhhmmss|
+
+###### 请求参数(body部分)
+|参数名称|约束|类型|长度|描述|取值说明|
+| :-: | :-: | :-: | :-: | :-: | :-: |
+|token|1|String|50|鉴权码|-|
+
+###### 返回协议
+
+当http返回状态不为200 时请求处理失败 body内容为失败的原因
+
+当http返回状态为200时请求处理成功，body内容为返回内容，
+
+|参数名称|约束|类型|长度|描述|取值说明|
+| :-: | :-: | :-: | :-: | :-: | :-:|
+|userId|1|String|30|用户ID|用户ID|
+
+
+
+###### 举例
+> 地址：[http://api.java110.com:8008/api/check.service.login](http://api.java110.com:8008/api/check.service.login)
+
+``` javascript
+请求头信息：
+Content-Type:application/json
+USER_ID:1234
+APP_ID:8000418002
+TRANSACTION_ID:10029082726
+REQ_TIME:20181113225612
+SIGN:aabdncdhdbd878sbdudn898
+请求报文：
+{
+	"token":"eyJ0eXAiOiJKV1QiLCJhbGciOiJIUzI1NiJ9.eyJpc3MiOiJqYXZhMTEwIiwianRpIjoiOGU1ZGY4NjBhYTUyNDgyNzk3MjBjZDFjNzg3ZDk4OTkifQ.PGwR_YjIDwn8sQFKr7CDmUk87MYt1lgi1s7a5OrE_Jg"
+}
+返回报文：
+{"userId":"10001"}
+```

docs/api/user/login.md

@@ -0,0 +1,63 @@
+
+
+**1\. 用户登录**
+###### 接口功能
+> 用户通过web端或APP登录系统
+
+###### URL
+> [http://api.java110.com:8008/api/user.service.login](http://api.java110.com:8008/api/user.service.login)
+
+###### 支持格式
+> JSON
+
+###### HTTP请求方式
+> POST
+
+###### 请求参数(header部分)
+|参数名称|约束|类型|长度|描述|取值说明|
+| :-: | :-: | :-: | :-: | :-: | :-:|
+|app_id|1|String|30|应用ID|Api服务分配                      |
+|transaction_id|1|String|30|请求流水号|不能重复 1000000000+YYYYMMDDhhmmss+6位序列 |
+|sign|1|String|-|签名|请参考签名说明|
+|req_time|1|String|-|请求时间|YYYYMMDDhhmmss|
+
+###### 请求参数(body部分)
+|参数名称|约束|类型|长度|描述|取值说明|
+| :-: | :-: | :-: | :-: | :-: | :-: |
+|username|1|String|50|用户名|-|
+|passwd|1|String|30|密码|-|
+
+###### 返回协议
+
+当http返回状态不为200 时请求处理失败 body内容为失败的原因
+
+当http返回状态为200时请求处理成功，body内容为返回内容，
+
+|参数名称|约束|类型|长度|描述|取值说明|
+| :-: | :-: | :-: | :-: | :-: | :-:|
+|userName|1|String|30|用户名称|用户名称|
+|userId|1|String|30|用户ID|用户ID|
+|token|?|String|64|鉴权码|鉴权码|
+
+
+
+###### 举例
+> 地址：[http://api.java110.com:8008/api/user.service.login](http://api.java110.com:8008/api/user.service.login)
+
+``` javascript
+请求头信息：
+Content-Type:application/json
+USER_ID:1234
+APP_ID:8000418002
+TRANSACTION_ID:10029082726
+REQ_TIME:20181113225612
+SIGN:aabdncdhdbd878sbdudn898
+请求报文：
+{
+	"username":"admin",
+	"passwd":"d57167e07915c9428b1c3aae57003807"
+}
+返回报文：
+{"userName":"admin","userId":"10001","token":"eyJ0eXAiOiJKV1QiLCJhbGciOiJIUzI1NiJ9.eyJpc3MiOiJqYXZhMTEwIiwianRpIjoiNmUzZGNjMzM3YmE4NGRmMTgxNzcwNDVjOTIzOTljOTAifQ.oUotKsoy1TXBS37isSvwKTQ9c_tTxZS48TA554QdbEU"}
+
+```

docs/api/user/register.md

@@ -45,6 +45,7 @@
 
 ###### 举例
 > 地址：[http://api.java110.com:8008/api/user.service.register](http://api.java110.com:8008/api/user.service.register)
+
 ``` javascript
 请求头信息：
 Content-Type:application/json

docs/api/utils/clearCache.md

@@ -37,6 +37,7 @@
 
 ###### 举例
 > 地址：[http://api.java110.com:8008/api/flush.center.cache?cache=All](http://api.java110.com:8008/api/flush.center.cache?cache=All)
+
 ``` javascript
 请求头信息：
 Content-Type:application/json