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/platform/PlatformController.java | 104 +++++++++++++++++++++++++++++++++++++++++++++++-----
1 files changed, 94 insertions(+), 10 deletions(-)
diff --git a/src/main/java/com/genersoft/iot/vmp/vmanager/platform/PlatformController.java b/src/main/java/com/genersoft/iot/vmp/vmanager/gb28181/platform/PlatformController.java
similarity index 68%
rename from src/main/java/com/genersoft/iot/vmp/vmanager/platform/PlatformController.java
rename to src/main/java/com/genersoft/iot/vmp/vmanager/gb28181/platform/PlatformController.java
index 834c00b..ce476f7 100644
--- a/src/main/java/com/genersoft/iot/vmp/vmanager/platform/PlatformController.java
+++ b/src/main/java/com/genersoft/iot/vmp/vmanager/gb28181/platform/PlatformController.java
@@ -1,14 +1,17 @@
-package com.genersoft.iot.vmp.vmanager.platform;
+package com.genersoft.iot.vmp.vmanager.gb28181.platform;
import com.alibaba.fastjson.JSONObject;
import com.genersoft.iot.vmp.gb28181.bean.ParentPlatform;
import com.genersoft.iot.vmp.gb28181.transmit.cmd.ISIPCommanderForPlatform;
import com.genersoft.iot.vmp.storager.IRedisCatchStorage;
import com.genersoft.iot.vmp.storager.IVideoManagerStorager;
-import com.genersoft.iot.vmp.vmanager.platform.bean.ChannelReduce;
-import com.genersoft.iot.vmp.vmanager.platform.bean.UpdateChannelParam;
+import com.genersoft.iot.vmp.vmanager.gb28181.platform.bean.ChannelReduce;
+import com.genersoft.iot.vmp.vmanager.gb28181.platform.bean.UpdateChannelParam;
import com.github.pagehelper.PageInfo;
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;
@@ -21,7 +24,7 @@
/**
* 绾ц仈骞冲彴绠＄悊
*/
-@Api("绾ц仈骞冲彴绠＄悊")
+@Api(tags = "绾ц仈骞冲彴绠＄悊")
@CrossOrigin
@RestController
@RequestMapping("/api/platform")
@@ -41,6 +44,11 @@
@Autowired
private SipConfig sipConfig;
+ /**
+ * 鑾峰彇鍥芥爣鏈嶅姟鐨勯厤缃�
+ * @return
+ */
+ @ApiOperation("鑾峰彇鍥芥爣鏈嶅姟鐨勯厤缃�")
@GetMapping("/server_config")
public ResponseEntity<JSONObject> serverConfig() {
JSONObject result = new JSONObject();
@@ -51,7 +59,18 @@
return new ResponseEntity<>(result, HttpStatus.OK);
}
+ /**
+ * 鍒嗛〉鏌ヨ绾ц仈骞冲彴
+ * @param page 褰撳墠椤�
+ * @param count 姣忛〉鏉℃暟
+ * @return
+ */
+ @ApiOperation("鍒嗛〉鏌ヨ绾ц仈骞冲彴")
@GetMapping("/query/{count}/{page}")
+ @ApiImplicitParams({
+ @ApiImplicitParam(name = "page", value = "褰撳墠椤�", dataTypeClass = Integer.class),
+ @ApiImplicitParam(name = "count", value = "姣忛〉鏉℃暟", dataTypeClass = Integer.class),
+ })
public PageInfo<ParentPlatform> platforms(@PathVariable int page, @PathVariable int count){
if (logger.isDebugEnabled()) {
@@ -60,6 +79,15 @@
return storager.queryParentPlatformList(page, count);
}
+ /**
+ * 淇濆瓨涓婄骇骞冲彴淇℃伅
+ * @param parentPlatform
+ * @return
+ */
+ @ApiOperation("淇濆瓨涓婄骇骞冲彴淇℃伅")
+ @ApiImplicitParams({
+ @ApiImplicitParam(name = "parentPlatform", value = "涓婄骇骞冲彴淇℃伅", dataTypeClass = ParentPlatform.class),
+ })
@PostMapping("/save")
@ResponseBody
public ResponseEntity<String> savePlatform(@RequestBody ParentPlatform parentPlatform){
@@ -96,13 +124,22 @@
commanderForPlatform.unregister(parentPlatform, null, null);
}
-
+
return new ResponseEntity<>("success", HttpStatus.OK);
} else {
return new ResponseEntity<>("fail", HttpStatus.OK);
}
}
+ /**
+ * 鍒犻櫎涓婄骇骞冲彴
+ * @param serverGBId 涓婄骇骞冲彴鍥芥爣ID
+ * @return
+ */
+ @ApiOperation("鍒犻櫎涓婄骇骞冲彴")
+ @ApiImplicitParams({
+ @ApiImplicitParam(name = "serverGBId", value = "涓婄骇骞冲彴鍥芥爣ID", dataTypeClass = String.class),
+ })
@DeleteMapping("/delete/{serverGBId}")
@ResponseBody
public ResponseEntity<String> deletePlatform(@PathVariable String serverGBId){
@@ -139,17 +176,47 @@
}
}
- @GetMapping("/exit/{deviceGbId}")
+ /**
+ * 鏌ヨ涓婄骇骞冲彴鏄惁瀛樺湪
+ * @param serverGBId 涓婄骇骞冲彴鍥芥爣ID
+ * @return
+ */
+ @ApiOperation("鏌ヨ涓婄骇骞冲彴鏄惁瀛樺湪")
+ @ApiImplicitParams({
+ @ApiImplicitParam(name = "serverGBId", value = "涓婄骇骞冲彴鍥芥爣ID", dataTypeClass = String.class),
+ })
+ @GetMapping("/exit/{serverGBId}")
@ResponseBody
- public ResponseEntity<String> exitPlatform(@PathVariable String deviceGbId){
+ public ResponseEntity<String> exitPlatform(@PathVariable String serverGBId){
if (logger.isDebugEnabled()) {
- logger.debug("鏌ヨ涓婄骇骞冲彴鏄惁瀛樺湪API璋冪敤锛�" + deviceGbId);
+ logger.debug("鏌ヨ涓婄骇骞冲彴鏄惁瀛樺湪API璋冪敤锛�" + serverGBId);
}
- ParentPlatform parentPlatform = storager.queryParentPlatById(deviceGbId);
+ ParentPlatform parentPlatform = storager.queryParentPlatById(serverGBId);
return new ResponseEntity<>(String.valueOf(parentPlatform != null), HttpStatus.OK);
}
+ /**
+ * 鍒嗛〉鏌ヨ绾ц仈骞冲彴鐨勬墍鏈夋墍鏈夐�氶亾
+ * @param page 褰撳墠椤�
+ * @param count 姣忛〉鏉℃暟
+ * @param platformId 涓婄骇骞冲彴ID
+ * @param query 鏌ヨ鍐呭
+ * @param online 鏄惁鍦ㄧ嚎
+ * @param choosed 鏄惁宸查�変腑
+ * @param channelType 閫氶亾绫诲瀷
+ * @return
+ */
+ @ApiOperation("鍒嗛〉鏌ヨ绾ц仈骞冲彴鐨勬墍鏈夋墍鏈夐�氶亾")
+ @ApiImplicitParams({
+ @ApiImplicitParam(name = "page", value = "褰撳墠椤�", dataTypeClass = Integer.class),
+ @ApiImplicitParam(name = "count", value = "姣忛〉鏉℃暟", dataTypeClass = Integer.class),
+ @ApiImplicitParam(name = "platformId", value = "涓婄骇骞冲彴ID", dataTypeClass = String.class),
+ @ApiImplicitParam(name = "query", value = "鏌ヨ鍐呭", dataTypeClass = String.class),
+ @ApiImplicitParam(name = "online", value = "鏄惁鍦ㄧ嚎", dataTypeClass = Boolean.class),
+ @ApiImplicitParam(name = "choosed", value = "鏄惁宸查�変腑", dataTypeClass = Boolean.class),
+ @ApiImplicitParam(name = "channelType", value = "閫氶亾绫诲瀷", dataTypeClass = Boolean.class),
+ })
@GetMapping("/channel_list")
@ResponseBody
public PageInfo<ChannelReduce> channelList(int page, int count,
@@ -172,7 +239,15 @@
return channelReduces;
}
-
+ /**
+ * 鍚戜笂绾у钩鍙版坊鍔犲浗鏍囬�氶亾
+ * @param param 閫氶亾鍏宠仈鍙傛暟
+ * @return
+ */
+ @ApiOperation("鍚戜笂绾у钩鍙版坊鍔犲浗鏍囬�氶亾")
+ @ApiImplicitParams({
+ @ApiImplicitParam(name = "param", value = "閫氶亾鍏宠仈鍙傛暟", dataTypeClass = UpdateChannelParam.class),
+ })
@PostMapping("/update_channel_for_gb")
@ResponseBody
public ResponseEntity<String> updateChannelForGB(@RequestBody UpdateChannelParam param){
@@ -185,6 +260,15 @@
return new ResponseEntity<>(String.valueOf(result > 0), HttpStatus.OK);
}
+ /**
+ * 浠庝笂绾у钩鍙扮Щ闄ゅ浗鏍囬�氶亾
+ * @param param 閫氶亾鍏宠仈鍙傛暟
+ * @return
+ */
+ @ApiOperation("浠庝笂绾у钩鍙扮Щ闄ゅ浗鏍囬�氶亾")
+ @ApiImplicitParams({
+ @ApiImplicitParam(name = "param", value = "閫氶亾鍏宠仈鍙傛暟", dataTypeClass = UpdateChannelParam.class),
+ })
@DeleteMapping("/del_channel_for_gb")
@ResponseBody
public ResponseEntity<String> delChannelForGB(@RequestBody UpdateChannelParam param){
--
Gitblit v1.8.0