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/play/PlayController.java |   35 ++++++++++++++++++++++++++++-------
 1 files changed, 28 insertions(+), 7 deletions(-)

diff --git a/src/main/java/com/genersoft/iot/vmp/vmanager/play/PlayController.java b/src/main/java/com/genersoft/iot/vmp/vmanager/gb28181/play/PlayController.java
similarity index 87%
rename from src/main/java/com/genersoft/iot/vmp/vmanager/play/PlayController.java
rename to src/main/java/com/genersoft/iot/vmp/vmanager/gb28181/play/PlayController.java
index df16dd8..1af7e6e 100644
--- a/src/main/java/com/genersoft/iot/vmp/vmanager/play/PlayController.java
+++ b/src/main/java/com/genersoft/iot/vmp/vmanager/gb28181/play/PlayController.java
@@ -1,4 +1,4 @@
-package com.genersoft.iot.vmp.vmanager.play;
+package com.genersoft.iot.vmp.vmanager.gb28181.play;
 
 import com.genersoft.iot.vmp.common.StreamInfo;
 import com.genersoft.iot.vmp.conf.MediaServerConfig;
@@ -7,9 +7,13 @@
 import com.genersoft.iot.vmp.gb28181.transmit.callback.RequestMessage;
 import com.genersoft.iot.vmp.media.zlm.ZLMRESTfulUtils;
 import com.genersoft.iot.vmp.storager.IRedisCatchStorage;
-import com.genersoft.iot.vmp.vmanager.play.bean.PlayResult;
+import com.genersoft.iot.vmp.vmanager.gb28181.play.bean.PlayResult;
 import com.genersoft.iot.vmp.service.IMediaService;
 import com.genersoft.iot.vmp.service.IPlayService;
+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;
@@ -31,6 +35,7 @@
 
 import javax.sip.message.Response;
 
+@Api(tags = "鍥芥爣璁惧鐐规挱")
 @CrossOrigin
 @RestController
 @RequestMapping("/api/play")
@@ -59,6 +64,11 @@
 	@Autowired
 	private IMediaService mediaService;
 
+	@ApiOperation("寮�濮嬬偣鎾�")
+	@ApiImplicitParams({
+			@ApiImplicitParam(name = "deviceId", value = "璁惧ID", dataTypeClass = String.class),
+			@ApiImplicitParam(name = "channelId", value = "閫氶亾ID", dataTypeClass = String.class),
+	})
 	@GetMapping("/start/{deviceId}/{channelId}")
 	public DeferredResult<ResponseEntity<String>> play(@PathVariable String deviceId,
 													   @PathVariable String channelId) {
@@ -79,6 +89,10 @@
 		return playResult.getResult();
 	}
 
+	@ApiOperation("鍋滄鐐规挱")
+	@ApiImplicitParams({
+			@ApiImplicitParam(name = "streamId", value = "瑙嗛娴両D", dataTypeClass = String.class),
+	})
 	@PostMapping("/stop/{streamId}")
 	public DeferredResult<ResponseEntity<String>> playStop(@PathVariable String streamId) {
 
@@ -139,6 +153,10 @@
 	 * @param streamId 娴両D
 	 * @return
 	 */
+	@ApiOperation("灏嗕笉鏄痟264鐨勮棰戦�氳繃ffmpeg 杞爜涓篽264 + aac")
+	@ApiImplicitParams({
+			@ApiImplicitParam(name = "streamId", value = "瑙嗛娴両D", dataTypeClass = String.class),
+	})
 	@PostMapping("/convert/{streamId}")
 	public ResponseEntity<String> playConvert(@PathVariable String streamId) {
 		StreamInfo streamInfo = redisCatchStorage.queryPlayByStreamId(streamId);
@@ -179,6 +197,10 @@
 	 * @param key
 	 * @return
 	 */
+	@ApiOperation("缁撴潫杞爜")
+	@ApiImplicitParams({
+			@ApiImplicitParam(name = "key", value = "瑙嗛娴乲ey", dataTypeClass = String.class),
+	})
 	@PostMapping("/convertStop/{key}")
 	public ResponseEntity<String> playConvertStop(@PathVariable String key) {
 
@@ -201,11 +223,10 @@
 		return new ResponseEntity<String>( result.toJSONString(), HttpStatus.OK);
 	}
 
-	/**
-     * 璇煶骞挎挱鍛戒护API鎺ュ彛
-     * 
-     * @param deviceId
-     */
+	@ApiOperation("璇煶骞挎挱鍛戒护")
+	@ApiImplicitParams({
+			@ApiImplicitParam(name = "deviceId", value = "璁惧Id", dataTypeClass = String.class),
+	})
     @GetMapping("/broadcast/{deviceId}")
     @PostMapping("/broadcast/{deviceId}")
     public DeferredResult<ResponseEntity<String>> broadcastApi(@PathVariable String deviceId) {

--
Gitblit v1.8.0