Browse Source

接口文档

郭超 4 years ago
parent
commit
7d3cf0b299

+ 1 - 1
src/main/java/edu/nju/controller/ExtraController.java

@@ -539,7 +539,7 @@ public class ExtraController {
 	 * @param id 任务ID
 	 * @param response
 	 */
-	@RequestMapping(value = "/getTask")
+	@GetMapping(value = "/getTask")
 	@ResponseBody
 	public void getTask(String id, HttpServletResponse response) {
 		try {

+ 23 - 8
src/main/java/edu/nju/controller/HistoryController.java

@@ -24,6 +24,9 @@ import edu.nju.service.AnalyzeService;
 import edu.nju.service.HistoryService;
 import edu.nju.service.RecommendService;
 
+/**
+ * 获取历史记录 /history
+ */
 @Controller
 @RequestMapping(value = "/history")
 @CrossOrigin(origins = "*", maxAge = 3600, allowCredentials = "true")
@@ -103,9 +106,9 @@ public class HistoryController {
 	/**
 	 * 获取所有形成树状结构的bug根节点
 	 * @param case_take_id
-	 * @param start
-	 * @param count
-	 * @param page
+	 * @param start 从第几个开始
+	 * @param count 显示几个
+	 * @param page 页面信息  eg:首页  or  首页——众测广场 or  首页——众测广场--任务
 	 * @param session
 	 * @param response
 	 */
@@ -231,8 +234,16 @@ public class HistoryController {
 		}
 	}
 
-	//学生获取所有单个节点的数据
-	@RequestMapping(value = "/getSingleStu")
+	/**
+	 * 学生获取所有单个节点的数据 /getSingleStu
+	 * @param case_take_id
+	 * @param start 从第几个开始
+	 * @param count 显示几个
+	 * @param page 页面信息  eg:首页  or  首页——众测广场 or  首页——众测广场--任务
+	 * @param session
+	 * @param response
+	 */
+	@GetMapping(value = "/getSingleStu")
 	@ResponseBody
 	public void getSingleStu(String case_take_id, String start, String count, String page, HttpSession session, HttpServletResponse response) {
 		try {
@@ -289,9 +300,13 @@ public class HistoryController {
 			e.printStackTrace();
 		}
 	}
-	
-	//获取指定bug的所有路径
-	@RequestMapping(value = "/getPath")
+
+	/**
+	 * 获取指定bug的所有路径 /getPath
+	 * @param id bugId
+	 * @param response
+	 */
+	@GetMapping(value = "/getPath")
 	@ResponseBody
 	public void getPath(String id, HttpServletResponse response) {
 		try {

+ 13 - 3
src/main/java/edu/nju/controller/RecommendController.java

@@ -235,9 +235,19 @@ public class RecommendController {
 			e.printStackTrace();
 		}
 	}
-	
-	//fork时,传回所有的选择参数
-	@RequestMapping(value = "/fork")
+
+	/**
+	 * fork时,传回所有的选择参数
+	 * @param page1
+	 * @param page2
+	 * @param page3
+	 * @param bug_category
+	 * @param severity
+	 * @param recurrent
+	 * @param session
+	 * @param response
+	 */
+	@GetMapping(value = "/fork")
 	@ResponseBody
 	public void fork(String page1, String page2, String page3, String bug_category, String severity, String recurrent, HttpSession session, HttpServletResponse response) {
 		try {

+ 7 - 2
src/main/java/edu/nju/controller/ReportController.java

@@ -64,8 +64,13 @@ public class ReportController {
 		}
 	}
 
-//	@AuthRequired
-	@RequestMapping(value = "/reportReview")
+	/**
+	 * 获取点赞点踩以及bug总数
+	 * @param report_id
+	 * @param case_take_id
+	 * @param response
+	 */
+	@GetMapping(value = "/reportReview")
 	@ResponseBody
 	public void getReportReview(String report_id, String case_take_id, HttpServletResponse response) {
 		try {