feat: Add support for processing inner classes in API export (#1258)

Author: tangcent

gradle.properties

@@ -3,4 +3,4 @@ plugin_version=2.8.2.212.0
 kotlin.code.style=official
 kotlin_version=2.1.0
 junit_version=5.9.2
-itangcent_intellij_version=1.7.9
+itangcent_intellij_version=1.8.0

idea-plugin/build.gradle.kts

@@ -8,7 +8,7 @@ version = properties["plugin_version"]!!
 val intellijVersions = arrayOf(
     mapOf("jdk" to 21, "version" to "2025.1.2", "since" to "251"),
     mapOf("jdk" to 17, "version" to "2023.1.3", "since" to "231"),
-    mapOf("jdk" to 15, "version" to "2022.2.3", "since" to "223"),
+    mapOf("jdk" to 15, "version" to "2022.2.3", "since" to "222"),
     mapOf("jdk" to 11, "version" to "2021.2.1", "since" to "212")
 )
 

idea-plugin/src/main/kotlin/com/itangcent/idea/plugin/api/ClassApiExporterHelper.kt

@@ -239,6 +239,9 @@ open class ClassApiExporterHelper {
                     break
                 }
             } else {
+                for (innerClass in psiClass.innerClasses) {
+                    psiClassQueue.add(innerClass)
+                }
                 val classQualifiedName = actionContext.callInReadUI { psiClass.qualifiedName }
                 LOG.info("Processing API for class: $classQualifiedName")
                 actionContext.withBoundary {

idea-plugin/src/test/kotlin/com/itangcent/idea/plugin/api/ClassApiExporterHelperTest.kt

@@ -78,9 +78,14 @@ class ClassApiExporterHelperTest : PluginContextLightCodeInsightFixtureTestCase(
         }
         actionContext.waitComplete()
 
+        //not contains methods from innerclass
+        assertEquals(4, methods.size)
+
         assertTrue(methods.contains("create"))
         assertTrue(methods.contains("get"))
         assertFalse(methods.contains("toString"))
+        //not contains methods from innerclass
+        assertFalse(methods.contains("getProfileSettings"))
     }
 
     fun testExport() {
@@ -89,6 +94,7 @@ class ClassApiExporterHelperTest : PluginContextLightCodeInsightFixtureTestCase(
 
         assertNotNull(docs)
         assertTrue(docs.isNotEmpty())
+        assertEquals(5, docs.size)
 
         // Verify first API doc
         docs[0].let { doc ->

idea-plugin/src/test/kotlin/com/itangcent/idea/plugin/api/export/yapi/YapiApiExporterTest.kt

@@ -112,6 +112,8 @@ internal abstract class YapiApiExporterTest : PluginContextLightCodeInsightFixtu
             builder.mock<YapiApiHelper> {
                 this.on { it.findCart(eq("token111111"), eq("apis about user")) }
                     .thenReturn(null, "111111")
+                this.on { it.findCart(eq("token111111"), eq("Nested API for user profile operations")) }
+                    .thenReturn("333333")
                 this.on { it.getProjectIdByToken(eq("token111111")) }
                     .thenReturn("12345")
                 this.on { it.addCart(any(), any(), any()) }
@@ -166,6 +168,8 @@ internal abstract class YapiApiExporterTest : PluginContextLightCodeInsightFixtu
                     .thenReturn("111111")
                 this.on { it.findCart(eq("token111111"), eq("test apis")) }
                     .thenReturn("222222")
+                this.on { it.findCart(eq("token111111"), eq("Nested API for user profile operations")) }
+                    .thenReturn("333333")
                 this.on { it.getProjectIdByToken(eq("token111111")) }
                     .thenReturn("12345")
                 this.on { it.getCartWeb(any(""), any("")) }

idea-plugin/src/test/resources/api/UserCtrl.java

@@ -7,6 +7,7 @@
 import com.itangcent.model.UserInfo;
 import org.springframework.web.bind.annotation.GetMapping;
 import org.springframework.web.bind.annotation.ModelAttribute;
+import org.springframework.web.bind.annotation.PathVariable;
 import org.springframework.web.bind.annotation.PostMapping;
 import org.springframework.web.bind.annotation.PutMapping;
 import org.springframework.web.bind.annotation.RequestMapping;
@@ -66,4 +67,29 @@ public Result<UserInfo> update(@ModelAttribute UserInfo userInfo) {
         return Result.success(userInfo);
     }
 
-}
+    /**
+     * Nested API for user profile operations
+     * 
+     * @module user-profiles
+     */
+    @RestController
+    @RequestMapping(value = "/profile")
+    public static class ProfileApi extends BaseController {
+        
+        /**
+         * Get user profile settings
+         * 
+         * @param userId The ID of the user whose profile settings to retrieve
+         * @return User profile settings
+         */
+        @GetMapping("/settings/{userId}")
+        public Result<UserInfo> getProfileSettings(@PathVariable("userId") Long userId) {
+            UserInfo userInfo = new UserInfo();
+            userInfo.setId(userId);
+            userInfo.setName("Profile User");
+            userInfo.setAge(30);
+            return Result.success(userInfo);
+        }
+    }
+
+}

idea-plugin/src/test/resources/result/com.itangcent.idea.plugin.api.export.markdown.MarkdownApiExporterTest.CustomizedDirectorySpringMarkdownApiExporterTest.txt

@@ -910,14 +910,131 @@ test apis
 
 
 
-## 1.2 apis about user
+## 1.2 Nested API for user profile operations
+
+Nested API for user profile operations
+
+
+---
+### 1.2.21 current ctrl name
+
+> `BASIC`
+
+**`Path params`:** /profile/ctrl/name
+
+**`Method`:** GET
+
+> `QUERY`
+
+**Headers:**
+
+| `name` | `value` | `desc` |
+| ------------ | ------------ | ----: |
+| token |  | auth token |
+
+
+
+> `Response`
+
+**Headers:**
+
+| `name` | `value` | `required` | `desc` |
+| ------------ | ------------ | ------------ | :----: |
+| content-type | application/json;charset=UTF-8 | N |  |
+
+**Body:**
+
+| `name` | `type` | `desc` |
+| ------------ | :----: | ------------ |
+|  | string |  |
+
+**`Response demo`:**
+
+```json
+
+```
+
+
+
+
+---
+### 1.2.22 Get user profile settings
+
+> `BASIC`
+
+**`Path params`:** /profile/settings/{userId}
+
+**`Method`:** GET
+
+> `QUERY`
+
+**Headers:**
+
+| `name` | `value` | `desc` |
+| ------------ | ------------ | ----: |
+| token |  | auth token |
+
+**Query:**
+
+| `name` | `value` | `required` | `desc` |
+| ------------ | ------------ | ------------ | ----: |
+| userId |  | N | The ID of the user whose profile settings to retrieve |
+
+
+
+> `Response`
+
+**Headers:**
+
+| `name` | `value` | `required` | `desc` |
+| ------------ | ------------ | ------------ | :----: |
+| content-type | application/json;charset=UTF-8 | N |  |
+
+**Body:**
+
+| `name` | `type` | `desc` |
+| ------------ | :----: | ------------ |
+| code | integer | response code |
+| msg | string | message |
+| data | object | response data |
+|   |─id | integer | user id |
+| &ensp;&ensp;&#124;─type | integer | user type<br>1 :administration<br>2 :a person, an animal or a plant<br>3 :Anonymous visitor |
+| &ensp;&ensp;&#124;─name | string | user name |
+| &ensp;&ensp;&#124;─age | integer | user age |
+| &ensp;&ensp;&#124;─sex | integer |  |
+| &ensp;&ensp;&#124;─birthDay | string | user birthDay |
+| &ensp;&ensp;&#124;─regtime | string | user regtime |
+
+**`Response demo`:**
+
+```json
+{
+  "code": 0,
+  "msg": "",
+  "data": {
+    "id": 0,
+    "type": 0,
+    "name": "",
+    "age": 0,
+    "sex": 0,
+    "birthDay": "",
+    "regtime": ""
+  }
+}
+```
+
+
+
+
+
+## 1.3 apis about user
 
 apis about user
 access user info
 
 
 ---
-### 1.2.21 current ctrl name
+### 1.3.23 current ctrl name
 
 > `BASIC`
 
@@ -959,7 +1076,7 @@ access user info
 
 
 ---
-### 1.2.22 say hello
+### 1.3.24 say hello
 
 > `BASIC`
 
@@ -997,7 +1114,7 @@ access user info
 
 
 ---
-### 1.2.23 get user info
+### 1.3.25 get user info
 
 > `BASIC`
 
@@ -1066,7 +1183,7 @@ access user info
 
 
 ---
-### 1.2.24 create an user
+### 1.3.26 create an user
 
 > `BASIC`
 
@@ -1156,7 +1273,7 @@ access user info
 
 
 ---
-### 1.2.25 update user info
+### 1.3.27 update user info
 
 > `BASIC`