规范api

panlinlin

2021-04-11 a004a978fa54779425d7498b4737c970b8c71f7b

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

File was renamed from src/main/java/com/genersoft/iot/vmp/vmanager/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（udp传输），TCP-ACTIVE（tcp主动模式,暂不支持），TCP-PASSIVE（tcp被动模式）"),
   })
@@ -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,