规范api

panlinlin

2021-04-11 a004a978fa54779425d7498b4737c970b8c71f7b

 src/main/java/com/genersoft/iot/vmp/vmanager/gb28181/device/DeviceControl.java

File was renamed from src/main/java/com/genersoft/iot/vmp/vmanager/device/DeviceControl.java
@@ -5,7 +5,7 @@
 * @date 2021年2月1日
 */

package com.genersoft.iot.vmp.vmanager.device;
package com.genersoft.iot.vmp.vmanager.gb28181.device;

import javax.sip.message.Response;

@@ -53,7 +53,7 @@
     */
   @ApiOperation("远程启动控制命令")
   @ApiImplicitParams({
         @ApiImplicitParam(name = "deviceId", value ="设备ID", required = true),
         @ApiImplicitParam(name = "deviceId", value ="设备ID", required = true, dataTypeClass = String.class),
   })
    @GetMapping("/teleboot/{deviceId}")
    public ResponseEntity<String> teleBootApi(@PathVariable String deviceId) {
@@ -82,10 +82,10 @@
     */
    @ApiOperation("录像控制命令")
   @ApiImplicitParams({
         @ApiImplicitParam(name = "deviceId", value ="设备ID", required = true),
         @ApiImplicitParam(name = "channelId", value ="通道编码"),
         @ApiImplicitParam(name = "deviceId", value ="设备ID", required = true, dataTypeClass = String.class),
         @ApiImplicitParam(name = "channelId", value ="通道编码" ,dataTypeClass = String.class),
         @ApiImplicitParam(name = "recordCmdStr", value ="命令， 可选值：Record（手动录像），StopRecord（停止手动录像）",
               required = true),
               required = true ,dataTypeClass = String.class),
   })
    @GetMapping("/record/{deviceId}/{recordCmdStr}")
    public DeferredResult<ResponseEntity<String>> recordApi(@PathVariable String deviceId,
@@ -122,8 +122,9 @@
    */
   @ApiOperation("录像控制命令")
   @ApiImplicitParams({
         @ApiImplicitParam(name = "deviceId", value = "设备ID", required = true),
         @ApiImplicitParam(name = "guardCmdStr", value ="命令， 可选值：SetGuard（布防），ResetGuard（撤防）", required = true)
         @ApiImplicitParam(name = "deviceId", value = "设备ID", required = true, dataTypeClass = String.class),
         @ApiImplicitParam(name = "guardCmdStr", value ="命令， 可选值：SetGuard（布防），ResetGuard（撤防）", required = true,
               dataTypeClass = String.class)
   })
   @GetMapping("/guard/{deviceId}/{guardCmdStr}")
   public DeferredResult<ResponseEntity<String>> guardApi(@PathVariable String deviceId, @PathVariable String guardCmdStr) {
@@ -160,9 +161,9 @@
    */
   @ApiOperation("报警复位")
   @ApiImplicitParams({
         @ApiImplicitParam(name = "deviceId", value = "设备ID", required = true),
         @ApiImplicitParam(name = "alarmMethod", value ="报警方式"),
         @ApiImplicitParam(name = "alarmType", value ="报警类型"),
         @ApiImplicitParam(name = "deviceId", value = "设备ID", required = true, dataTypeClass = String.class),
         @ApiImplicitParam(name = "alarmMethod", value ="报警方式", dataTypeClass = String.class),
         @ApiImplicitParam(name = "alarmType", value ="报警类型", dataTypeClass = String.class),
   })
   @GetMapping("/reset_alarm/{deviceId}")
   public DeferredResult<ResponseEntity<String>> resetAlarmApi(@PathVariable String deviceId, 
@@ -200,8 +201,8 @@
    */
   @ApiOperation("强制关键帧")
   @ApiImplicitParams({
         @ApiImplicitParam(name = "deviceId", value = "设备ID", required = true),
         @ApiImplicitParam(name = "channelId", value ="通道ID", required = true),
         @ApiImplicitParam(name = "deviceId", value = "设备ID", required = true, dataTypeClass = String.class),
         @ApiImplicitParam(name = "channelId", value ="通道ID", required = true, dataTypeClass = String.class),
   })
   @GetMapping("/i_frame/{deviceId}")
   public ResponseEntity<String> iFrame(@PathVariable String deviceId,
@@ -234,11 +235,11 @@
    */
   @ApiOperation("看守位控制")
   @ApiImplicitParams({
         @ApiImplicitParam(name = "deviceId", value = "设备ID", required = true),
         @ApiImplicitParam(name = "enabled", value = "是否开启看守位 1:开启,0:关闭", required = true),
         @ApiImplicitParam(name = "resetTime", value = "自动归位时间间隔"),
         @ApiImplicitParam(name = "presetIndex", value = "调用预置位编号"),
         @ApiImplicitParam(name = "channelId", value ="通道ID"),
         @ApiImplicitParam(name = "deviceId", value = "设备ID", required = true, dataTypeClass = String.class),
         @ApiImplicitParam(name = "enabled", value = "是否开启看守位 1:开启,0:关闭", required = true, dataTypeClass = String.class),
         @ApiImplicitParam(name = "resetTime", value = "自动归位时间间隔", dataTypeClass = String.class),
         @ApiImplicitParam(name = "presetIndex", value = "调用预置位编号", dataTypeClass = String.class),
         @ApiImplicitParam(name = "channelId", value ="通道ID", dataTypeClass = String.class),
   })
   @GetMapping("/home_position/{deviceId}/{enabled}")
   public DeferredResult<ResponseEntity<String>> homePositionApi(@PathVariable String deviceId,