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/device/DeviceQuery.java | 62 +++++++++++++++---------------
1 files changed, 31 insertions(+), 31 deletions(-)
diff --git a/src/main/java/com/genersoft/iot/vmp/vmanager/device/DeviceQuery.java b/src/main/java/com/genersoft/iot/vmp/vmanager/gb28181/device/DeviceQuery.java
similarity index 88%
rename from src/main/java/com/genersoft/iot/vmp/vmanager/device/DeviceQuery.java
rename to src/main/java/com/genersoft/iot/vmp/vmanager/gb28181/device/DeviceQuery.java
index bded1b9..e243d23 100644
--- a/src/main/java/com/genersoft/iot/vmp/vmanager/device/DeviceQuery.java
+++ b/src/main/java/com/genersoft/iot/vmp/vmanager/gb28181/device/DeviceQuery.java
@@ -1,4 +1,4 @@
-package com.genersoft.iot.vmp.vmanager.device;
+package com.genersoft.iot.vmp.vmanager.gb28181.device;
import com.genersoft.iot.vmp.gb28181.bean.DeviceChannel;
import com.genersoft.iot.vmp.gb28181.transmit.callback.RequestMessage;
@@ -22,7 +22,7 @@
import javax.sip.message.Response;
-@Api(tags = "鍥芥爣璁惧鏌ヨ1", value = "鍥芥爣璁惧鏌ヨ")
+@Api(tags = "鍥芥爣璁惧鏌ヨ", value = "鍥芥爣璁惧鏌ヨ")
@SuppressWarnings("rawtypes")
@CrossOrigin
@RestController
@@ -50,7 +50,7 @@
*/
@ApiOperation("浣跨敤ID鏌ヨ鍥芥爣璁惧")
@ApiImplicitParams({
- @ApiImplicitParam(name = "deviceId", value = "璁惧ID", required = true),
+ @ApiImplicitParam(name = "deviceId", value = "璁惧ID", required = true, dataTypeClass = String.class),
})
@GetMapping("/devices/{deviceId}")
public ResponseEntity<Device> devices(@PathVariable String deviceId){
@@ -71,8 +71,8 @@
*/
@ApiOperation("鍒嗛〉鏌ヨ鍥芥爣璁惧")
@ApiImplicitParams({
- @ApiImplicitParam(name = "page", value = "褰撳墠椤�", required = true),
- @ApiImplicitParam(name = "count", value = "姣忛〉鏌ヨ鏁伴噺", required = true),
+ @ApiImplicitParam(name = "page", value = "褰撳墠椤�", required = true, dataTypeClass = Integer.class),
+ @ApiImplicitParam(name = "count", value = "姣忛〉鏌ヨ鏁伴噺", required = true, dataTypeClass = Integer.class),
})
@GetMapping("/devices")
public PageInfo<Device> devices(int page, int count){
@@ -98,12 +98,12 @@
@ApiOperation("鍒嗛〉鏌ヨ閫氶亾")
@GetMapping("/devices/{deviceId}/channels")
@ApiImplicitParams({
- @ApiImplicitParam(name="deviceId", value = "璁惧id", required = true),
- @ApiImplicitParam(name="page", value = "褰撳墠椤�", required = true),
- @ApiImplicitParam(name="count", value = "姣忛〉鏌ヨ鏁伴噺", required = true),
- @ApiImplicitParam(name="query", value = "鏌ヨ鍐呭"),
- @ApiImplicitParam(name="online", value = "鏄惁鍦ㄧ嚎"),
- @ApiImplicitParam(name="channelType", value = "璁惧/瀛愮洰褰�-> false/true"),
+ @ApiImplicitParam(name="deviceId", value = "璁惧id", required = true ,dataTypeClass = String.class),
+ @ApiImplicitParam(name="page", value = "褰撳墠椤�", required = true ,dataTypeClass = Integer.class),
+ @ApiImplicitParam(name="count", value = "姣忛〉鏌ヨ鏁伴噺", required = true ,dataTypeClass = Integer.class),
+ @ApiImplicitParam(name="query", value = "鏌ヨ鍐呭" ,dataTypeClass = String.class),
+ @ApiImplicitParam(name="online", value = "鏄惁鍦ㄧ嚎" ,dataTypeClass = Boolean.class),
+ @ApiImplicitParam(name="channelType", value = "璁惧/瀛愮洰褰�-> false/true" ,dataTypeClass = Boolean.class),
})
public ResponseEntity<PageInfo> channels(@PathVariable String deviceId,
int page, int count,
@@ -128,7 +128,7 @@
*/
@ApiOperation("鍚屾璁惧閫氶亾")
@ApiImplicitParams({
- @ApiImplicitParam(name="deviceId", value = "璁惧id", required = true),
+ @ApiImplicitParam(name="deviceId", value = "璁惧id", required = true ,dataTypeClass = String.class),
})
@PostMapping("/devices/{deviceId}/sync")
public DeferredResult<ResponseEntity<Device>> devicesSync(@PathVariable String deviceId){
@@ -165,7 +165,7 @@
*/
@ApiOperation("绉婚櫎璁惧")
@ApiImplicitParams({
- @ApiImplicitParam(name="deviceId", value = "璁惧id", required = true),
+ @ApiImplicitParam(name="deviceId", value = "璁惧id", required = true, dataTypeClass = String.class),
})
@DeleteMapping("/devices/{deviceId}/delete")
public ResponseEntity<String> delete(@PathVariable String deviceId){
@@ -201,13 +201,13 @@
*/
@ApiOperation("鍒嗛〉鏌ヨ瀛愮洰褰曢�氶亾")
@ApiImplicitParams({
- @ApiImplicitParam(name="deviceId", value = "璁惧id", required = true),
- @ApiImplicitParam(name="channelId", value = "閫氶亾id", required = true),
- @ApiImplicitParam(name="page", value = "褰撳墠椤�", required = true),
- @ApiImplicitParam(name="count", value = "姣忛〉鏉℃暟", required = true),
- @ApiImplicitParam(name="query", value = "鏌ヨ鍐呭"),
- @ApiImplicitParam(name="online", value = "鏄惁鍦ㄧ嚎"),
- @ApiImplicitParam(name="channelType", value = "閫氶亾绫诲瀷锛� 瀛愮洰褰�"),
+ @ApiImplicitParam(name="deviceId", value = "璁惧id", required = true, dataTypeClass = String.class),
+ @ApiImplicitParam(name="channelId", value = "閫氶亾id", required = true, dataTypeClass = String.class),
+ @ApiImplicitParam(name="page", value = "褰撳墠椤�", required = true, dataTypeClass = Integer.class),
+ @ApiImplicitParam(name="count", value = "姣忛〉鏉℃暟", required = true, dataTypeClass = Integer.class),
+ @ApiImplicitParam(name="query", value = "鏌ヨ鍐呭", dataTypeClass = String.class),
+ @ApiImplicitParam(name="online", value = "鏄惁鍦ㄧ嚎", dataTypeClass = String.class),
+ @ApiImplicitParam(name="channelType", value = "閫氶亾绫诲瀷锛� 瀛愮洰褰�", dataTypeClass = Boolean.class),
})
@GetMapping("/sub_channels/{deviceId}/{channelId}/channels")
public ResponseEntity<PageInfo> subChannels(@PathVariable String deviceId,
@@ -239,8 +239,8 @@
*/
@ApiOperation("鏇存柊閫氶亾淇℃伅")
@ApiImplicitParams({
- @ApiImplicitParam(name="deviceId", value = "璁惧id", required = true),
- @ApiImplicitParam(name="channel", value = "閫氶亾", required = true),
+ @ApiImplicitParam(name="deviceId", value = "璁惧id", required = true, dataTypeClass = String.class),
+ @ApiImplicitParam(name="channel", value = "閫氶亾", required = true, dataTypeClass = String.class),
})
@PostMapping("/channel/update/{deviceId}")
public ResponseEntity<PageInfo> updateChannel(@PathVariable String deviceId,DeviceChannel channel){
@@ -256,7 +256,7 @@
*/
@ApiOperation("淇敼鏁版嵁娴佷紶杈撴ā寮�")
@ApiImplicitParams({
- @ApiImplicitParam(name = "deviceId", value = "璁惧id", required = true),
+ @ApiImplicitParam(name = "deviceId", value = "璁惧id", required = true, dataTypeClass = String.class),
@ApiImplicitParam(name = "streamMode", value = "鏁版嵁娴佷紶杈撴ā寮�, 鍙栧�硷細" +
"UDP锛坲dp浼犺緭锛夛紝TCP-ACTIVE锛坱cp涓诲姩妯″紡,鏆備笉鏀寔锛夛紝TCP-PASSIVE锛坱cp琚姩妯″紡锛�"),
})
@@ -275,7 +275,7 @@
*/
@ApiOperation("璁惧鐘舵�佹煡璇�")
@ApiImplicitParams({
- @ApiImplicitParam(name = "deviceId", value = "璁惧id", required = true),
+ @ApiImplicitParam(name = "deviceId", value = "璁惧id", required = true, dataTypeClass = String.class),
})
@GetMapping("/devices/{deviceId}/status")
public DeferredResult<ResponseEntity<String>> deviceStatusApi(@PathVariable String deviceId) {
@@ -316,13 +316,13 @@
*/
@ApiOperation("璁惧鎶ヨ鏌ヨ")
@ApiImplicitParams({
- @ApiImplicitParam(name = "deviceId", value = "璁惧id", required = true),
- @ApiImplicitParam(name = "startPriority", value = "鎶ヨ璧峰绾у埆"),
- @ApiImplicitParam(name = "endPriority", value = "鎶ヨ缁堟绾у埆"),
- @ApiImplicitParam(name = "alarmMethod", value = "鎶ヨ鏂瑰紡鏉′欢"),
- @ApiImplicitParam(name = "alarmType", value = "鎶ヨ绫诲瀷"),
- @ApiImplicitParam(name = "startTime", value = "鎶ヨ鍙戠敓璧峰鏃堕棿"),
- @ApiImplicitParam(name = "endTime", value = "鎶ヨ鍙戠敓缁堟鏃堕棿"),
+ @ApiImplicitParam(name = "deviceId", value = "璁惧id", required = true, dataTypeClass = String.class),
+ @ApiImplicitParam(name = "startPriority", value = "鎶ヨ璧峰绾у埆", dataTypeClass = String.class),
+ @ApiImplicitParam(name = "endPriority", value = "鎶ヨ缁堟绾у埆", dataTypeClass = String.class),
+ @ApiImplicitParam(name = "alarmMethod", value = "鎶ヨ鏂瑰紡鏉′欢", dataTypeClass = String.class),
+ @ApiImplicitParam(name = "alarmType", value = "鎶ヨ绫诲瀷", dataTypeClass = String.class),
+ @ApiImplicitParam(name = "startTime", value = "鎶ヨ鍙戠敓璧峰鏃堕棿", dataTypeClass = String.class),
+ @ApiImplicitParam(name = "endTime", value = "鎶ヨ鍙戠敓缁堟鏃堕棿", dataTypeClass = String.class),
})
@GetMapping("/alarm/{deviceId}")
public DeferredResult<ResponseEntity<String>> alarmApi(@PathVariable String deviceId,
--
Gitblit v1.8.0