Quellcode durchsuchen

调整文档目录

吴学文 vor 7 Jahren
Ursprung
Commit
1667c4a42e
3 geänderte Dateien mit 56 neuen und 2 gelöschten Zeilen
  1. 3 1
      docs/_sidebar.md
  2. 53 0
      docs/api/utils/clearCache.md
  3. 0 1
      docs/index.html

+ 3 - 1
docs/_sidebar.md

@@ -16,4 +16,6 @@
   ## [编码生成服务接口协议](code)
   ## [编码生成服务接口测试文档](code_test)
 # api接口
-  ## [用户注册](api/user/register)
+  ## [用户注册](api/user/register)
+# 工具类接口
+  ## [刷新缓存](api/utils/clearCache)

+ 53 - 0
docs/api/utils/clearCache.md

@@ -0,0 +1,53 @@
+
+
+**1\. 刷新缓存**
+###### 接口功能
+> 当修改数据库配置后需要手工调用接口刷新缓存
+
+###### URL
+> [http://api.java110.com:8008/api/flush.center.cache?cache=All](http://api.java110.com:8008/api/flush.center.cache?cache=All)
+
+###### 支持格式
+> JSON
+
+###### HTTP请求方式
+> GET
+
+###### 请求参数(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部分)
+|参数名称|约束|类型|长度|描述|取值说明|
+| :-: | :-: | :-: | :-: | :-: | :-: |
+|cache|1|String|50|缓存类别|-|
+
+###### 返回协议
+
+当http返回状态不为200 时请求处理失败 body内容为失败的原因
+
+当http返回状态为200时请求处理成功,body内容为返回内容,
+
+
+
+
+###### 举例
+> 地址:[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
+USER_ID:1234
+APP_ID:8000418002
+TRANSACTION_ID:10029082726
+REQ_TIME:20181113225612
+SIGN:aabdncdhdbd878sbdudn898
+请求报文:
+无
+返回报文:
+刷新缓存成功
+
+```

+ 0 - 1
docs/index.html

@@ -15,7 +15,6 @@
 <script>
     window.$docsify = {
       loadSidebar: true,
-      subMaxLevel: 2
     }
   </script>
 <script src="//unpkg.com/docsify/lib/docsify.min.js"></script>