Merge pull request #45 from lizhen789/master

添加请求和响应示例的开关配置项

src/main/java/com/power/doc/builder/DocBuilderTemplate.java

@@ -106,6 +106,8 @@ public class DocBuilderTemplate extends BaseDocBuilderTemplate {
         tpl.binding(TemplateVariable.VERSION.getVariable(), now);
         tpl.binding(TemplateVariable.CREATE_TIME.getVariable(), strTime);
         tpl.binding(TemplateVariable.PROJECT_NAME.getVariable(), config.getProjectName());
+        tpl.binding(TemplateVariable.REQUEST_EXAMPLE.getVariable(), config.isRequestExample());
+        tpl.binding(TemplateVariable.RESPONSE_EXAMPLE.getVariable(), config.isResponseExample());
         if (CollectionUtil.isEmpty(errorCodeList)) {
             tpl.binding(TemplateVariable.DICT_ORDER.getVariable(), apiDocList.size() + 1);
         } else {

src/main/java/com/power/doc/constants/TemplateVariable.java

@@ -46,9 +46,9 @@ public enum TemplateVariable {
     PROTOCOL("protocol"),
     AUTHOR("author"),
     URI("uri"),
-    RPC_CONSUMER_CONFIG("consumerConfigExample")
+    RPC_CONSUMER_CONFIG("consumerConfigExample"),
-    ;
+    REQUEST_EXAMPLE("isRequestExample"),
-
+    RESPONSE_EXAMPLE("isResponseExample");
 
     private String variable;
 

src/main/java/com/power/doc/model/ApiConfig.java

@@ -204,7 +204,14 @@ public class ApiConfig {
      */
     private int recursionLimit = 7;
 
-
+    /**
+     * request example
+     */
+    private boolean isRequestExample;
+    /**
+     * response example
+     */
+    private boolean isResponseExample;
     public String getServerUrl() {
         return serverUrl;
     }
@@ -447,5 +454,19 @@ public class ApiConfig {
         this.recursionLimit = recursionLimit;
     }
 
+    public boolean isRequestExample() {
+        return isRequestExample;
+    }
 
+    public void setRequestExample(boolean requestExample) {
+        isRequestExample = requestExample;
+    }
+
+    public boolean isResponseExample() {
+        return isResponseExample;
+    }
+
+    public void setResponseExample(boolean responseExample) {
+        isResponseExample = responseExample;
+    }
 }

src/main/resources/default.json

@@ -8,6 +8,8 @@
   "md5EncryptedHtmlName": false,
   "projectName": "smart-doc",
   "skipTransientField": true,
+  "isRequestExample": true,
+  "isResponseExample": true,
   "revisionLogs": [
     {
       "version": "1.0",

src/main/resources/template/AllInOne.adoc

@@ -64,7 +64,7 @@ for(param in doc.requestParams){
 |====================
 <%}%>
 
-<%if(isNotEmpty(doc.requestUsage)){%>
+<%if(isNotEmpty(doc.requestUsage)&&isRequestExample){%>
 *Request-example:*
 ----
 ${doc.requestUsage}
@@ -85,7 +85,7 @@ for(param in doc.responseParams){
 |====================
 <%}%>
 
-<%if(isNotEmpty(doc.responseUsage)){%>
+<%if(isNotEmpty(doc.responseUsage)&&isResponseExample){%>
 *Response-example:*
 ----
 ${doc.responseUsage}

src/main/resources/template/AllInOne.btl

@@ -57,7 +57,7 @@ ${param.field}|${param.type}|${param.desc}|${param.required}|${param.version}
 <%}%>
 <%}%>
 
-<%if(isNotEmpty(doc.requestUsage)){%>
+<%if(isNotEmpty(doc.requestUsage)&&isRequestExample){%>
 **Request-example:**
 ```
 ${doc.requestUsage}
@@ -75,7 +75,7 @@ ${param.field}|${param.type}|${param.desc}|${param.version}
 <%}%>
 <%}%>
 
-<%if(isNotEmpty(doc.responseUsage)){%>
+<%if(isNotEmpty(doc.responseUsage)&&isResponseExample){%>
 **Response-example:**
 ```
 ${doc.responseUsage}

src/main/resources/template/ApiDoc.adoc

@@ -46,7 +46,7 @@ for(param in doc.requestParams){
 <%}%>
 |====================
 
-<%if(isNotEmpty(doc.requestUsage)){%>
+<%if(isNotEmpty(doc.requestUsage)&&isRequestExample){%>
 *Request-example:*
 ----
 ${doc.requestUsage}
@@ -67,7 +67,7 @@ for(param in doc.responseParams){
 <%}%>
 |====================
 
-<%if(isNotEmpty(doc.responseUsage)){%>
+<%if(isNotEmpty(doc.responseUsage)&&isResponseExample){%>
 *Response-example:*
 ----
 ${doc.responseUsage}

src/main/resources/template/ApiDoc.btl

@@ -40,7 +40,7 @@ ${param.field}|${param.type}|${param.desc}|${param.required}|${param.version}
 <%}%>
 <%}%>
 
-<%if(isNotEmpty(doc.requestUsage)){%>
+<%if(isNotEmpty(doc.requestUsage)&&isRequestExample){%>
 **Request-example:**
 ```
 ${doc.requestUsage}
@@ -58,7 +58,7 @@ ${param.field}|${param.type}|${param.desc}|${param.version}
 <%}%>
 <%}%>
 
-<%if(isNotEmpty(doc.responseUsage)){%>
+<%if(isNotEmpty(doc.responseUsage)&&isResponseExample){%>
 **Response-example:**
 ```
 ${doc.responseUsage}

src/main/resources/template/index-temp.btl

@@ -91,7 +91,7 @@
              </tbody>
              </table>
              <%}%>
-             <%if(isNotEmpty(doc.requestUsage)){%>
+             <%if(isNotEmpty(doc.requestUsage)&&isRequestExample){%>
              <p><strong>Request-example:</strong></p>
              <pre><code>${doc.requestUsage}
              </code></pre>
@@ -113,7 +113,7 @@
              </table>
              <%}%>
 
-             <%if(isNotEmpty(doc.responseUsage)){%>
+             <%if(isNotEmpty(doc.responseUsage)&&isResponseExample){%>
               <p><strong>Response-example:</strong></p>
               <pre><code>${doc.responseUsage}
               </code></pre>