Merge pull request #491 from younker99/master

添加DocJavaMethod自定义拓展 #488

src/main/java/com/power/doc/handler/ICustomJavaMethodHandler.java

@@ -0,0 +1,38 @@
+/*
+ * smart-doc https://github.com/smart-doc-group/smart-doc
+ *
+ * Copyright (C) 2018-2023 smart-doc
+ *
+ * Licensed to the Apache Software Foundation (ASF) under one
+ * or more contributor license agreements.  See the NOTICE file
+ * distributed with this work for additional information
+ * regarding copyright ownership.  The ASF licenses this file
+ * to you under the Apache License, Version 2.0 (the
+ * "License"); you may not use this file except in compliance
+ * with the License.  You may obtain a copy of the License at
+ *
+ *   http://www.apache.org/licenses/LICENSE-2.0
+ *
+ * Unless required by applicable law or agreed to in writing,
+ * software distributed under the License is distributed on an
+ * "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY
+ * KIND, either express or implied.  See the License for the
+ * specific language governing permissions and limitations
+ * under the License.
+ */
+package com.power.doc.handler;
+
+import com.power.doc.model.DocJavaMethod;
+import com.thoughtworks.qdox.model.JavaClass;
+
+import java.util.List;
+
+/**
+ * handle customized operation for {@link DocJavaMethod}.
+ *
+ * @author yangyang
+ */
+@FunctionalInterface
+public interface ICustomJavaMethodHandler {
+    List<DocJavaMethod> apply(JavaClass cls, List<DocJavaMethod> methodList);
+}

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

@@ -29,6 +29,7 @@
 
 import com.power.common.util.CollectionUtil;
 import com.power.doc.constants.DocLanguage;
+import com.power.doc.handler.ICustomJavaMethodHandler;
 import com.power.doc.model.rpc.RpcApiDependency;
 
 /**
@@ -348,6 +349,10 @@ public class ApiConfig {
      * @since 2.2.5
      */
     private boolean responseParamsTable = Boolean.TRUE;
+    /**
+     * @since 2.6.8
+     */
+    private ICustomJavaMethodHandler customJavaMethodHandler;
 
     public String getCodePath() {
         return codePath;
@@ -928,4 +933,12 @@ public String getServerEnv() {
     public void setServerEnv(String serverEnv) {
         this.serverEnv = serverEnv;
     }
+
+    public ICustomJavaMethodHandler getCustomJavaMethodHandler() {
+        return customJavaMethodHandler;
+    }
+
+    public void setCustomJavaMethodHandler(ICustomJavaMethodHandler customJavaMethodHandler) {
+        this.customJavaMethodHandler = customJavaMethodHandler;
+    }
 }

src/main/java/com/power/doc/template/IRestDocTemplate.java

@@ -329,6 +329,10 @@ default List<ApiMethodDoc> buildEntryPointMethod(
                 }
             }
         }
+        // call ICustomJavaMethodHandler
+        if (apiConfig.getCustomJavaMethodHandler() != null) {
+            docJavaMethods = apiConfig.getCustomJavaMethodHandler().apply(cls, docJavaMethods);
+        }
         List<ApiMethodDoc> methodDocList = new ArrayList<>(methods.size());
         int methodOrder = 0;
         for (DocJavaMethod docJavaMethod : docJavaMethods) {