smartDoc

servers/boe-server-all/pom.xml

@@ -240,6 +240,18 @@
             <version>2.3.0</version> <!-- 请根据实际需求选择版本 -->
         </dependency>
 
+        <!-- https://mvnrepository.com/artifact/com.github.shalousun/smart-doc -->
+        <dependency>
+            <groupId>com.github.shalousun</groupId>
+            <artifactId>smart-doc</artifactId>
+            <version>2.7.7</version>
+        </dependency>
+
+        <dependency>
+            <groupId>javax.enterprise</groupId>
+            <artifactId>cdi-api</artifactId>
+            <version>2.0</version>
+        </dependency>
     </dependencies>
     <build>
         <plugins>
@@ -265,6 +277,28 @@
                     <includeSystemScope>true</includeSystemScope>
                 </configuration>
             </plugin>
+            <plugin>
+                <groupId>com.github.shalousun</groupId>
+                <artifactId>smart-doc-maven-plugin</artifactId>
+                <version>2.7.7</version>
+                <configuration>
+                    <!--指定生成文档的使用的配置文件,配置文件放在自己的项目中-->
+                    <configFile>./src/main/resources/smart-doc.json</configFile>
+                    <!--指定项目名称，推荐使用动态参数，例如${project.description}-->
+                    <!--如果smart-doc.json中和此处都未设置projectName，2.3.4开始，插件自动采用pom中的projectName作为设置-->
+                    <projectName>${project.description}</projectName>
+                </configuration>
+                <executions>
+                    <execution>
+                        <!--如果不需要在执行编译时启动smart-doc，则将phase注释掉-->
+                        <phase>compile</phase>
+                        <goals>
+                            <!--smart-doc提供了html、openapi、markdown等goal，可按需配置-->
+                            <goal>html</goal>
+                        </goals>
+                    </execution>
+                </executions>
+            </plugin>
         </plugins>
     </build>
     <profiles>

servers/boe-server-all/src/main/java/com/xboe/module/boecase/service/ICasesRecommendPushRecordService.java

@@ -14,7 +14,7 @@ public interface ICasesRecommendPushRecordService {
     /**
      * 案例推送
      *
-     * @param
+     * @param boeParam
      * @return
      */
     boolean launchPush(CasesRecommendLaunchVo casesRecommendLaunch, CurrentUser currentUser, String token);

servers/boe-server-all/src/main/java/com/xboe/module/interaction/service/ICommentsService.java

@@ -104,7 +104,7 @@ public interface ICommentsService {
 
 	/**
 	 * 查询案例@的评论
-	 * @param
+	 * @param boeParam
 	 * */
 
 	PageList<CommentsDto> findCasesTome(int pageIndex,int pageSize,Integer objType,String toaid,String uname,Boolean isread);

servers/boe-server-all/src/main/java/com/xboe/school/study/api/StudyCourseApi.java

@@ -288,7 +288,7 @@ public class StudyCourseApi extends ApiBaseController{
 	
 	/**
 	 * 记录学习信息，在学习每个资源时都要记录.前端用户打开课程资源按规则调用带着课程及学习信息调用此接口。
-	 * @param
+	 * @param boeParam
 	 * @return 返回学习条目的id
 	 */
 	@PostMapping("/study")
@@ -450,8 +450,8 @@ public class StudyCourseApi extends ApiBaseController{
 	 * 音视频学习保存,初始化保存学习记录.
 	 * 如果已经保存，就不要再保存第二次了，前端注意控制
 	 * {studyId,contentId,courseId,progress,contentType,studyDuration}
-	 * @param
-	 * @param
+	 * @param boeParam
+	 * @param boeParam
 	 * @return
 	 */
 	@PostMapping("/study-video-save")
@@ -506,8 +506,8 @@ public class StudyCourseApi extends ApiBaseController{
 	}
 	/**
 	 * 视频学习完
-	 * @param
-	 * @param
+	 * @param boeParam
+	 * @param boeParam
 	 * @return
 	 */
 	@PostMapping("/study-video-finish")
@@ -539,7 +539,7 @@ public class StudyCourseApi extends ApiBaseController{
 	/**
 	 * 记录视频的学习时间点，前端可以每10秒记录一次，时长是秒
 	 * @param itemId 学习内容条目id
-	 * @param
+	 * @param boeParam
 	 * @return
 	 */
 	@PostMapping("/study-video-time")

servers/boe-server-all/src/main/resources/smart-doc.json

@@ -0,0 +1,7 @@
+{
+  "outPath": "src/main/resources/apidoc",
+  "isStrict": false,
+  "ignoreEmptyTag": true,
+  "createDebugPage": true,
+  "allInOne": true
+}