From a004a978fa54779425d7498b4737c970b8c71f7b Mon Sep 17 00:00:00 2001
From: panlinlin <648540858@qq.com>
Date: 星期日, 11 四月 2021 22:32:28 +0800
Subject: [PATCH] 规范api

---
 src/main/java/com/genersoft/iot/vmp/vmanager/gb28181/ptz/PtzController.java |   72 ++++++++++++++++++++---------------
 1 files changed, 41 insertions(+), 31 deletions(-)

diff --git a/src/main/java/com/genersoft/iot/vmp/vmanager/ptz/PtzController.java b/src/main/java/com/genersoft/iot/vmp/vmanager/gb28181/ptz/PtzController.java
similarity index 66%
rename from src/main/java/com/genersoft/iot/vmp/vmanager/ptz/PtzController.java
rename to src/main/java/com/genersoft/iot/vmp/vmanager/gb28181/ptz/PtzController.java
index 1efdd3d..7e57e0d 100644
--- a/src/main/java/com/genersoft/iot/vmp/vmanager/ptz/PtzController.java
+++ b/src/main/java/com/genersoft/iot/vmp/vmanager/gb28181/ptz/PtzController.java
@@ -1,5 +1,9 @@
-package com.genersoft.iot.vmp.vmanager.ptz;
+package com.genersoft.iot.vmp.vmanager.gb28181.ptz;
 
+import io.swagger.annotations.Api;
+import io.swagger.annotations.ApiImplicitParam;
+import io.swagger.annotations.ApiImplicitParams;
+import io.swagger.annotations.ApiOperation;
 import org.slf4j.Logger;
 import org.slf4j.LoggerFactory;
 import org.springframework.beans.factory.annotation.Autowired;
@@ -17,22 +21,23 @@
 import com.genersoft.iot.vmp.gb28181.utils.XmlUtil;
 import com.genersoft.iot.vmp.storager.IVideoManagerStorager;
 
+@Api(tags = "浜戝彴鎺у埗")
 @CrossOrigin
 @RestController
-@RequestMapping("/api")
+@RequestMapping("/api/ptz")
 public class PtzController {
-	
+
 	private final static Logger logger = LoggerFactory.getLogger(PtzController.class);
-	
+
 	@Autowired
 	private SIPCommander cmder;
-	
+
 	@Autowired
 	private IVideoManagerStorager storager;
 
 	@Autowired
 	private DeferredResultHolder resultHolder;
-	
+
 	/***
 	 * 浜戝彴鎺у埗
 	 * @param deviceId 璁惧id
@@ -43,49 +48,54 @@
 	 * @param zoomSpeed	    缂╂斁閫熷害
 	 * @return String 鎺у埗缁撴灉
 	 */
-	@PostMapping("/ptz/{deviceId}/{channelId}")
+	@ApiOperation("浜戝彴鎺у埗")
+	@ApiImplicitParams({
+			@ApiImplicitParam(name = "deviceId", value = "璁惧ID", dataTypeClass = String.class),
+			@ApiImplicitParam(name = "channelId", value = "閫氶亾ID", dataTypeClass = String.class),
+			@ApiImplicitParam(name = "cmdCode", value = "鎸囦护鐮�", dataTypeClass = Integer.class),
+			@ApiImplicitParam(name = "horizonSpeed", value = "姘村钩閫熷害", dataTypeClass = Integer.class),
+			@ApiImplicitParam(name = "verticalSpeed", value = "鍨傜洿閫熷害", dataTypeClass = Integer.class),
+			@ApiImplicitParam(name = "zoomSpeed", value = "缂╂斁閫熷害", dataTypeClass = Integer.class),
+	})
+	@PostMapping("/control/{deviceId}/{channelId}")
 	public ResponseEntity<String> ptz(@PathVariable String deviceId,@PathVariable String channelId,int cmdCode, int horizonSpeed, int verticalSpeed, int zoomSpeed){
-		
+
 		if (logger.isDebugEnabled()) {
 			logger.debug(String.format("璁惧浜戝彴鎺у埗 API璋冪敤锛宒eviceId锛�%s 锛宑hannelId锛�%s 锛宑mdCode锛�%d 锛宧orizonSpeed锛�%d 锛寁erticalSpeed锛�%d 锛寊oomSpeed锛�%d",deviceId, channelId, cmdCode, horizonSpeed, verticalSpeed, zoomSpeed));
 		}
 		Device device = storager.queryVideoDevice(deviceId);
-		
+
 		cmder.frontEndCmd(device, channelId, cmdCode, horizonSpeed, verticalSpeed, zoomSpeed);
 		return new ResponseEntity<String>("success",HttpStatus.OK);
 	}
 
-	/**
-	 * 閫氱敤鍓嶇鎺у埗鍛戒护API鎺ュ彛
-	 * 
-	 * @param deviceId
-	 * @param channelId
-	 * @param cmdCode
-	 * @param parameter1
-	 * @param parameter2
-	 * @param combindCode2
-	 * @return
-	 */
-	@PostMapping("/frontEndCommand/{deviceId}/{channelId}")
+	@ApiOperation("閫氱敤鍓嶇鎺у埗鍛戒护")
+	@ApiImplicitParams({
+			@ApiImplicitParam(name = "deviceId", value = "璁惧ID", dataTypeClass = String.class),
+			@ApiImplicitParam(name = "channelId", value = "閫氶亾ID", dataTypeClass = String.class),
+			@ApiImplicitParam(name = "cmdCode", value = "鎸囦护鐮�", dataTypeClass = Integer.class),
+			@ApiImplicitParam(name = "parameter1", value = "鏁版嵁涓�", dataTypeClass = Integer.class),
+			@ApiImplicitParam(name = "parameter2", value = "鏁版嵁浜�", dataTypeClass = Integer.class),
+			@ApiImplicitParam(name = "combindCode2", value = "缁勫悎鐮佷簩", dataTypeClass = Integer.class),
+	})
+	@PostMapping("/front_end_command/{deviceId}/{channelId}")
 	public ResponseEntity<String> frontEndCommand(@PathVariable String deviceId,@PathVariable String channelId,int cmdCode, int parameter1, int parameter2, int combindCode2){
-		
+
 		if (logger.isDebugEnabled()) {
 			logger.debug(String.format("璁惧浜戝彴鎺у埗 API璋冪敤锛宒eviceId锛�%s 锛宑hannelId锛�%s 锛宑mdCode锛�%d parameter1锛�%d parameter2锛�%d",deviceId, channelId, cmdCode, parameter1, parameter2));
 		}
 		Device device = storager.queryVideoDevice(deviceId);
-		
+
 		cmder.frontEndCmd(device, channelId, cmdCode, parameter1, parameter2, combindCode2);
 		return new ResponseEntity<String>("success",HttpStatus.OK);
 	}
 
-	/**
-	 * 棰勭疆浣嶆煡璇㈠懡浠PI鎺ュ彛
-	 * 
-	 * @param deviceId
-	 * @param channelId
-	 * @return
-	 */
-	@GetMapping("/presetQuery/{deviceId}/{channelId}")
+	@ApiOperation("棰勭疆浣嶆煡璇�")
+	@ApiImplicitParams({
+            @ApiImplicitParam(name = "deviceId", value = "璁惧ID", dataTypeClass = String.class),
+            @ApiImplicitParam(name = "channelId", value = "閫氶亾ID", dataTypeClass = String.class),
+	})
+	@GetMapping("/preset/query/{deviceId}/{channelId}")
 	public DeferredResult<ResponseEntity<String>> presetQueryApi(@PathVariable String deviceId, @PathVariable String channelId) {
 		if (logger.isDebugEnabled()) {
 			logger.debug("璁惧棰勭疆浣嶆煡璇PI璋冪敤");

--
Gitblit v1.8.0