Просмотр исходного кода

添加用户退出登录接口

吴学文 лет назад: 7
Родитель
Сommit
21ee1c8c7e
2 измененных файлов с 56 добавлено и 0 удалено
  1. 1 0
      docs/_sidebar.md
  2. 55 0
      docs/api/user/logout.md

+ 1 - 0
docs/_sidebar.md

@@ -9,6 +9,7 @@
   * [用户注册](api/user/register.md)
   * [用户登录](api/user/login.md)
   * [用户校验登录](api/user/checkLogin.md)
+  * [用户退出登录](api/user/logout.md)
   * [保存商户](api/store/saveStore.md)
 
 * 服务端接口协议

+ 55 - 0
docs/api/user/logout.md

@@ -0,0 +1,55 @@
+
+
+**1\. 用户退出登录**
+###### 接口功能
+> 用户通过web端或APP退出系统
+
+###### URL
+> [http://api.java110.com:8008/api/user.service.logout](http://api.java110.com:8008/api/user.service.logout)
+
+###### 支持格式
+> 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|?|String|64|鉴权码|鉴权码|
+
+###### 返回协议
+
+当http返回状态不为200 时请求处理失败 body内容为失败的原因
+
+当http返回状态为200时请求处理成功,body内容为返回内容,
+
+
+
+
+###### 举例
+> 地址:[http://api.java110.com:8008/api/user.service.logout](http://api.java110.com:8008/api/user.service.logout)
+
+``` javascript
+请求头信息:
+Content-Type:application/json
+USER_ID:1234
+APP_ID:8000418002
+TRANSACTION_ID:10029082726
+REQ_TIME:20181113225612
+SIGN:aabdncdhdbd878sbdudn898
+请求报文:
+{
+	"token":"eyJ0eXAiOiJKV1QiLCJhbGciOiJIUzI1NiJ9.eyJpc3MiOiJqYXZhMTEwIiwianRpIjoiYWQ0ZjRjODUyZjI4NGY0Yjk4ODQzZDE3MmI4MmNmYTYifQ.p0KrdYX3-bifZ036WYCoyFQjoAo5_7bY1NXTwwOHPuk"
+}
+返回报文:
+退出登录成功
+```