Bläddra i källkod

modify README

sunyj 8 år sedan
förälder
incheckning
aec7a35fb3
1 ändrade filer med 75 tillägg och 1 borttagningar
  1. 75 1
      kanban-console/README.md

+ 75 - 1
kanban-console/README.md

@@ -48,7 +48,7 @@
 ## 请求方式
   如无特殊说明,均以 **POST** 方式请求
 
-## 请求出错
+## <span id="请求出错">请求出错</span>
   前台访问各个接口时,如果后台处理正确,会返回给前台各个接口指定的返回值。如果后台出现任何错误,如参数不合法、不允许的操作等,均会以下列的形式返回
 <table border=0 cellpadding=5 cellspacing=0>
     <tr style="color:#fff">
@@ -685,6 +685,43 @@
     </tr>
 </table>
 
+## 校验 SQL
+- 路径
+`
+/parameter/validateSQL
+`
+
+- 参数
+<table border=0 cellpadding=5 cellspacing=0>
+    <tr style="color:#fff">
+        <th>参数名称</th>
+        <th>参数类型</th>
+        <th>描述</th>
+    </tr>
+    <tr>
+        <td>panelCode</td>
+        <td>String</td>
+        <td>面板 code</td>
+    </tr>
+    <tr>
+        <td>sql</td>
+        <td>String</td>
+        <td>SQL 语句</td>
+    </tr>
+</table>
+
+- 返回值
+<table border=0 cellpadding=5 cellspacing=0>
+    <tr style="color:#fff">
+        <th>类型</th>
+        <th>描述</th>
+    </tr>
+    <tr>
+        <td>Boolean</td>
+        <td>执行成功返回 true,失败时请参照[请求出错](#请求出错)</td>
+    </tr>
+</table>
+
 # 看板
 ## <span id="看板数据字典">数据字典</span>
 <table border=0 cellpadding=5 cellspacing=0>
@@ -774,6 +811,43 @@
     </tr>
 </table>
 
+## 校验 SQL
+- 路径
+`
+/kanban/validateSQL
+`
+
+- 参数
+<table border=0 cellpadding=5 cellspacing=0>
+    <tr style="color:#fff">
+        <th>参数名称</th>
+        <th>参数类型</th>
+        <th>描述</th>
+    </tr>
+    <tr>
+        <td>panelCode</td>
+        <td>String</td>
+        <td>面板 code</td>
+    </tr>
+    <tr>
+        <td>sql</td>
+        <td>String</td>
+        <td>SQL 语句</td>
+    </tr>
+</table>
+
+- 返回值
+<table border=0 cellpadding=5 cellspacing=0>
+    <tr style="color:#fff">
+        <th>类型</th>
+        <th>描述</th>
+    </tr>
+    <tr>
+        <td>Boolean</td>
+        <td>执行成功返回 true,失败时请参照[请求出错](#请求出错)</td>
+    </tr>
+</table>
+
 # 看板历史记录
 ## <span id="看板历史记录数据字典">数据字典</span>
 <table border=0 cellpadding=5 cellspacing=0>