From 2310087e03ebc785a3e67f6d85ab4166b6f05ca0 Mon Sep 17 00:00:00 2001 From: panlinlin <648540858@qq.com> Date: Wed, 7 Apr 2021 18:35:13 +0800 Subject: [PATCH] =?UTF-8?q?=E8=A7=84=E8=8C=83=E5=8C=96api=EF=BC=8C=20?= =?UTF-8?q?=E8=BF=9B=E8=A1=8C=E4=B8=AD=E3=80=82=E3=80=82=E3=80=82?= MIME-Version: 1.0 Content-Type: text/plain; charset=UTF-8 Content-Transfer-Encoding: 8bit --- pom.xml | 13 +- .../genersoft/iot/vmp/VManageBootstrap.java | 2 + .../iot/vmp/conf/Swagger3Config.java | 41 ++++++ .../transmit/cmd/impl/SIPCommander.java | 2 +- .../iot/vmp/vmanager/device/DeviceConfig.java | 46 ++++-- .../vmp/vmanager/device/DeviceControl.java | 70 +++++++--- .../iot/vmp/vmanager/device/DeviceQuery.java | 131 ++++++++++++++++-- .../vmanager/gbStream/GbStreamController.java | 43 +++++- .../iot/vmp/vmanager/play/PlayController.java | 10 +- .../vmanager/playback/PlaybackController.java | 6 +- src/main/resources/application-dev.yml | 8 +- web_src/src/components/DeviceList.vue | 7 +- web_src/src/components/channelList.vue | 10 +- .../src/components/dialog/devicePlayer.vue | 8 +- 14 files changed, 321 insertions(+), 76 deletions(-) create mode 100644 src/main/java/com/genersoft/iot/vmp/conf/Swagger3Config.java diff --git a/pom.xml b/pom.xml index c2f5d82f..dda226d3 100644 --- a/pom.xml +++ b/pom.xml @@ -102,18 +102,15 @@ - + io.springfox - springfox-swagger2 - 2.9.2 - - - io.springfox - springfox-swagger-ui - 2.6.1 + springfox-boot-starter + 3.0.0 + + javax.validation validation-api diff --git a/src/main/java/com/genersoft/iot/vmp/VManageBootstrap.java b/src/main/java/com/genersoft/iot/vmp/VManageBootstrap.java index d237b165..89de84ee 100644 --- a/src/main/java/com/genersoft/iot/vmp/VManageBootstrap.java +++ b/src/main/java/com/genersoft/iot/vmp/VManageBootstrap.java @@ -5,8 +5,10 @@ import java.util.logging.LogManager; import org.springframework.boot.SpringApplication; import org.springframework.boot.autoconfigure.SpringBootApplication; import org.springframework.context.ConfigurableApplicationContext; +import springfox.documentation.oas.annotations.EnableOpenApi; @SpringBootApplication +@EnableOpenApi public class VManageBootstrap extends LogManager { private static String[] args; private static ConfigurableApplicationContext context; diff --git a/src/main/java/com/genersoft/iot/vmp/conf/Swagger3Config.java b/src/main/java/com/genersoft/iot/vmp/conf/Swagger3Config.java new file mode 100644 index 00000000..70be1882 --- /dev/null +++ b/src/main/java/com/genersoft/iot/vmp/conf/Swagger3Config.java @@ -0,0 +1,41 @@ +package com.genersoft.iot.vmp.conf; + +import io.swagger.annotations.ApiOperation; +import org.springframework.context.annotation.Bean; +import org.springframework.context.annotation.Configuration; +import springfox.documentation.builders.ApiInfoBuilder; +import springfox.documentation.builders.PathSelectors; +import springfox.documentation.builders.RequestHandlerSelectors; +import springfox.documentation.builders.RequestParameterBuilder; +import springfox.documentation.schema.ScalarType; +import springfox.documentation.service.ApiInfo; +import springfox.documentation.service.Contact; +import springfox.documentation.spi.DocumentationType; +import springfox.documentation.spring.web.plugins.Docket; + +import java.util.ArrayList; +import java.util.List; + +@Configuration +public class Swagger3Config { + + @Bean + public Docket createRestApi() { + return new Docket(DocumentationType.OAS_30) + .apiInfo(apiInfo()) + .select() + .apis(RequestHandlerSelectors.basePackage("com.genersoft.iot.vmp.vmanager")) + .paths(PathSelectors.any()) + .build() + .pathMapping("/"); + } + + private ApiInfo apiInfo() { + return new ApiInfoBuilder() + .title("WVP-PRO 接口文档") + .description("更多请咨询服务开发者(18010473990@@163.com)。") + .contact(new Contact("Ray。", "http://www.ruiyeclub.cn", "ruiyeclub@foxmail.com")) + .version("1.0") + .build(); + } +} diff --git a/src/main/java/com/genersoft/iot/vmp/gb28181/transmit/cmd/impl/SIPCommander.java b/src/main/java/com/genersoft/iot/vmp/gb28181/transmit/cmd/impl/SIPCommander.java index 579e168b..27402ba7 100644 --- a/src/main/java/com/genersoft/iot/vmp/gb28181/transmit/cmd/impl/SIPCommander.java +++ b/src/main/java/com/genersoft/iot/vmp/gb28181/transmit/cmd/impl/SIPCommander.java @@ -341,7 +341,7 @@ public class SIPCommander implements ISIPCommander { @Override public void playStreamCmd(Device device, String channelId, ZLMHttpHookSubscribe.Event event, SipSubscribe.Event errorEvent) { try { - + if (device == null) return; String ssrc = streamSession.createPlaySsrc(); String streamId = null; if (rtpEnable) { diff --git a/src/main/java/com/genersoft/iot/vmp/vmanager/device/DeviceConfig.java b/src/main/java/com/genersoft/iot/vmp/vmanager/device/DeviceConfig.java index d046c0df..a9885504 100644 --- a/src/main/java/com/genersoft/iot/vmp/vmanager/device/DeviceConfig.java +++ b/src/main/java/com/genersoft/iot/vmp/vmanager/device/DeviceConfig.java @@ -17,16 +17,22 @@ import com.genersoft.iot.vmp.gb28181.transmit.cmd.impl.SIPCommander; import com.genersoft.iot.vmp.gb28181.utils.XmlUtil; import com.genersoft.iot.vmp.storager.IVideoManagerStorager; +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; +import org.springframework.http.HttpRequest; import org.springframework.http.ResponseEntity; import org.springframework.web.bind.annotation.*; import org.springframework.web.context.request.async.DeferredResult; +@Api(tags = "国标设备配置") @CrossOrigin @RestController -@RequestMapping("/api") +@RequestMapping("/api/device/config") public class DeviceConfig { private final static Logger logger = LoggerFactory.getLogger(DeviceQuery.class); @@ -42,14 +48,24 @@ public class DeviceConfig { /** * 看守位控制命令API接口 - * - * @param deviceId - * @param enabled 看守位使能1:开启,0:关闭 - * @param resetTime 自动归位时间间隔（可选） - * @param presetIndex 调用预置位编号（可选） - * @param channelId 通道编码（可选） + * @param deviceId 设备ID + * @param channelId 通道ID + * @param name 名称 + * @param expiration 到期时间 + * @param heartBeatInterval 心跳间隔 + * @param heartBeatCount 心跳计数 + * @return */ - @GetMapping("/config/{deviceId}/basicParam") + @ApiOperation("看守位控制命令") + @GetMapping("/basicParam/{deviceId}") + @ApiImplicitParams({ + @ApiImplicitParam(name = "deviceId", value ="设备ID" ), + @ApiImplicitParam(name = "channelId", value ="通道ID" ), + @ApiImplicitParam(name = "name", value ="名称" ), + @ApiImplicitParam(name = "expiration", value ="到期时间" ), + @ApiImplicitParam(name = "heartBeatInterval", value ="心跳间隔" ), + @ApiImplicitParam(name = "heartBeatCount", value ="心跳计数" ), + }) public DeferredResult> homePositionApi(@PathVariable String deviceId, @RequestParam(required = false) String channelId, @RequestParam(required = false) String name, @@ -86,10 +102,18 @@ public class DeviceConfig { /** * 设备配置查询请求API接口 - * - * @param deviceId + * @param deviceId 设备ID + * @param configType 配置类型 + * @param channelId 通道ID + * @return */ - @GetMapping("/config/{deviceId}/query/{configType}") + @ApiOperation("设备配置查询请求") + @ApiImplicitParams({ + @ApiImplicitParam(name = "deviceId", value ="设备ID" ), + @ApiImplicitParam(name = "channelId", value ="通道ID" ), + @ApiImplicitParam(name = "configType", value ="配置类型" ), + }) + @GetMapping("/query/{deviceId}/{configType}") public DeferredResult> configDownloadApi(@PathVariable String deviceId, @PathVariable String configType, @RequestParam(required = false) String channelId) { diff --git a/src/main/java/com/genersoft/iot/vmp/vmanager/device/DeviceControl.java b/src/main/java/com/genersoft/iot/vmp/vmanager/device/DeviceControl.java index 72213594..ae517aff 100644 --- a/src/main/java/com/genersoft/iot/vmp/vmanager/device/DeviceControl.java +++ b/src/main/java/com/genersoft/iot/vmp/vmanager/device/DeviceControl.java @@ -17,6 +17,10 @@ import com.genersoft.iot.vmp.gb28181.transmit.cmd.impl.SIPCommander; import com.genersoft.iot.vmp.gb28181.utils.XmlUtil; import com.genersoft.iot.vmp.storager.IVideoManagerStorager; +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; @@ -25,9 +29,10 @@ import org.springframework.http.ResponseEntity; import org.springframework.web.bind.annotation.*; import org.springframework.web.context.request.async.DeferredResult; +@Api(tags = "国标设备控制") @CrossOrigin @RestController -@RequestMapping("/api") +@RequestMapping("/api/device/control") public class DeviceControl { private final static Logger logger = LoggerFactory.getLogger(DeviceQuery.class); @@ -44,10 +49,13 @@ public class DeviceControl { /** * 远程启动控制命令API接口 * - * @param deviceId + * @param deviceId 设备ID */ - @GetMapping("/control/{deviceId}/teleboot") - @PostMapping("/control/{deviceId}/teleboot") + @ApiOperation("远程启动控制命令") + @ApiImplicitParams({ + @ApiImplicitParam(name = "deviceId", value ="设备ID", required = true), + }) + @GetMapping("/teleboot/{deviceId}") public ResponseEntity teleBootApi(@PathVariable String deviceId) { if (logger.isDebugEnabled()) { logger.debug("设备远程启动API调用"); @@ -68,11 +76,18 @@ public class DeviceControl { /** * 录像控制命令API接口 * - * @param deviceId + * @param deviceId 设备ID * @param recordCmdStr Record：手动录像，StopRecord：停止手动录像 * @param channelId 通道编码（可选） */ - @GetMapping("/control/{deviceId}/record/{recordCmdStr}") + @ApiOperation("录像控制命令") + @ApiImplicitParams({ + @ApiImplicitParam(name = "deviceId", value ="设备ID", required = true), + @ApiImplicitParam(name = "channelId", value ="通道编码"), + @ApiImplicitParam(name = "recordCmdStr", value ="命令， 可选值：Record（手动录像），StopRecord（停止手动录像）", + required = true), + }) + @GetMapping("/record/{deviceId}/{recordCmdStr}") public DeferredResult> recordApi(@PathVariable String deviceId, @PathVariable String recordCmdStr, @RequestParam(required = false) String channelId) { if (logger.isDebugEnabled()) { @@ -102,10 +117,15 @@ public class DeviceControl { /** * 报警布防/撤防命令API接口 * - * @param deviceId + * @param deviceId 设备ID * @param guardCmdStr SetGuard：布防，ResetGuard：撤防 */ - @GetMapping("/control/{deviceId}/guard/{guardCmdStr}") + @ApiOperation("录像控制命令") + @ApiImplicitParams({ + @ApiImplicitParam(name = "deviceId", value = "设备ID", required = true), + @ApiImplicitParam(name = "guardCmdStr", value ="命令， 可选值：SetGuard（布防），ResetGuard（撤防）", required = true) + }) + @GetMapping("/guard/{deviceId}/{guardCmdStr}") public DeferredResult> guardApi(@PathVariable String deviceId, @PathVariable String guardCmdStr) { if (logger.isDebugEnabled()) { logger.debug("布防/撤防API调用"); @@ -134,11 +154,17 @@ public class DeviceControl { /** * 报警复位API接口 * - * @param deviceId + * @param deviceId 设备ID * @param alarmMethod 报警方式（可选） * @param alarmType 报警类型（可选） */ - @GetMapping("/control/{deviceId}/resetAlarm") + @ApiOperation("报警复位") + @ApiImplicitParams({ + @ApiImplicitParam(name = "deviceId", value = "设备ID", required = true), + @ApiImplicitParam(name = "alarmMethod", value ="报警方式"), + @ApiImplicitParam(name = "alarmType", value ="报警类型"), + }) + @GetMapping("/reset_alarm/{deviceId}") public DeferredResult> resetAlarmApi(@PathVariable String deviceId, @RequestParam(required = false) String alarmMethod, @RequestParam(required = false) String alarmType) { @@ -169,11 +195,15 @@ public class DeviceControl { /** * 强制关键帧API接口 * - * @param deviceId - * @param channelId + * @param deviceId 设备ID + * @param channelId 通道ID */ - @GetMapping("/control/{deviceId}/iFrame") - @PostMapping("/control/{deviceId}/iFrame") + @ApiOperation("强制关键帧") + @ApiImplicitParams({ + @ApiImplicitParam(name = "deviceId", value = "设备ID", required = true), + @ApiImplicitParam(name = "channelId", value ="通道ID", required = true), + }) + @GetMapping("/i_frame/{deviceId}") public ResponseEntity iFrame(@PathVariable String deviceId, @RequestParam(required = false) String channelId) { if (logger.isDebugEnabled()) { @@ -196,13 +226,21 @@ public class DeviceControl { /** * 看守位控制命令API接口 * - * @param deviceId + * @param deviceId 设备ID * @param enabled 看守位使能1:开启,0:关闭 * @param resetTime 自动归位时间间隔（可选） * @param presetIndex 调用预置位编号（可选） * @param channelId 通道编码（可选） */ - @GetMapping("/control/{deviceId}/homePosition/{enabled}") + @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"), + }) + @GetMapping("/home_position/{deviceId}/{enabled}") public DeferredResult> homePositionApi(@PathVariable String deviceId, @PathVariable String enabled, @RequestParam(required = false) String resetTime, diff --git a/src/main/java/com/genersoft/iot/vmp/vmanager/device/DeviceQuery.java b/src/main/java/com/genersoft/iot/vmp/vmanager/device/DeviceQuery.java index 997a43b2..bded1b97 100644 --- a/src/main/java/com/genersoft/iot/vmp/vmanager/device/DeviceQuery.java +++ b/src/main/java/com/genersoft/iot/vmp/vmanager/device/DeviceQuery.java @@ -3,6 +3,7 @@ package com.genersoft.iot.vmp.vmanager.device; import com.genersoft.iot.vmp.gb28181.bean.DeviceChannel; import com.genersoft.iot.vmp.gb28181.transmit.callback.RequestMessage; import com.github.pagehelper.PageInfo; +import io.swagger.annotations.*; import org.slf4j.Logger; import org.slf4j.LoggerFactory; import org.springframework.beans.factory.annotation.Autowired; @@ -21,10 +22,11 @@ import com.genersoft.iot.vmp.storager.IVideoManagerStorager; import javax.sip.message.Response; +@Api(tags = "国标设备查询1", value = "国标设备查询") @SuppressWarnings("rawtypes") @CrossOrigin @RestController -@RequestMapping("/api") +@RequestMapping("/api/device/query") public class DeviceQuery { private final static Logger logger = LoggerFactory.getLogger(DeviceQuery.class); @@ -40,7 +42,16 @@ public class DeviceQuery { @Autowired private DeviceOffLineDetector offLineDetector; - + + /** + * 使用ID查询国标设备 + * @param deviceId 国标ID + * @return 国标设备 + */ + @ApiOperation("使用ID查询国标设备") + @ApiImplicitParams({ + @ApiImplicitParam(name = "deviceId", value = "设备ID", required = true), + }) @GetMapping("/devices/{deviceId}") public ResponseEntity devices(@PathVariable String deviceId){ @@ -51,7 +62,18 @@ public class DeviceQuery { Device device = storager.queryVideoDevice(deviceId); return new ResponseEntity<>(device,HttpStatus.OK); } - + + /** + * 分页查询国标设备 + * @param page 当前页 + * @param count 每页查询数量 + * @return 分页国标列表 + */ + @ApiOperation("分页查询国标设备") + @ApiImplicitParams({ + @ApiImplicitParam(name = "page", value = "当前页", required = true), + @ApiImplicitParam(name = "count", value = "每页查询数量", required = true), + }) @GetMapping("/devices") public PageInfo devices(int page, int count){ @@ -73,7 +95,16 @@ public class DeviceQuery { * @param channelType 设备 false/子目录 true * @return 通道列表 */ + @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"), + }) public ResponseEntity channels(@PathVariable String deviceId, int page, int count, @RequestParam(required = false) String query, @@ -89,7 +120,16 @@ public class DeviceQuery { PageInfo pageResult = storager.queryChannelsByDeviceId(deviceId, query, channelType, online, page, count); return new ResponseEntity<>(pageResult,HttpStatus.OK); } - + + /** + * 同步设备通道 + * @param deviceId 设备id + * @return + */ + @ApiOperation("同步设备通道") + @ApiImplicitParams({ + @ApiImplicitParam(name="deviceId", value = "设备id", required = true), + }) @PostMapping("/devices/{deviceId}/sync") public DeferredResult> devicesSync(@PathVariable String deviceId){ @@ -117,8 +157,17 @@ public class DeviceQuery { resultHolder.put(DeferredResultHolder.CALLBACK_CMD_CATALOG+deviceId, result); return result; } - - @PostMapping("/devices/{deviceId}/delete") + + /** + * 移除设备 + * @param deviceId 设备id + * @return + */ + @ApiOperation("移除设备") + @ApiImplicitParams({ + @ApiImplicitParam(name="deviceId", value = "设备id", required = true), + }) + @DeleteMapping("/devices/{deviceId}/delete") public ResponseEntity delete(@PathVariable String deviceId){ if (logger.isDebugEnabled()) { @@ -140,13 +189,27 @@ public class DeviceQuery { } /** - * 分页查询通道数 + * 分页查询子目录通道 + * @param deviceId 通道id * @param channelId 通道id * @param page 当前页 * @param count 每页条数 + * @param query 查询内容 + * @param online 是否在线 + * @param channelType 通道类型 * @return 子通道列表 */ - @GetMapping("/subChannels/{deviceId}/{channelId}/channels") + @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 = "通道类型， 子目录"), + }) + @GetMapping("/sub_channels/{deviceId}/{channelId}/channels") public ResponseEntity subChannels(@PathVariable String deviceId, @PathVariable String channelId, int page, @@ -168,14 +231,36 @@ public class DeviceQuery { return new ResponseEntity<>(pageResult,HttpStatus.OK); } + /** + * 更新通道信息 + * @param deviceId 设备id + * @param channel 通道 + * @return + */ + @ApiOperation("更新通道信息") + @ApiImplicitParams({ + @ApiImplicitParam(name="deviceId", value = "设备id", required = true), + @ApiImplicitParam(name="channel", value = "通道", required = true), + }) @PostMapping("/channel/update/{deviceId}") public ResponseEntity updateChannel(@PathVariable String deviceId,DeviceChannel channel){ storager.updateChannel(deviceId, channel); return new ResponseEntity<>(null,HttpStatus.OK); } - @GetMapping("/devices/{deviceId}/transport/{streamMode}") - @PostMapping("/devices/{deviceId}/transport/{streamMode}") + /** + * 修改数据流传输模式 + * @param deviceId 设备id + * @param streamMode 数据流传输模式 + * @return + */ + @ApiOperation("修改数据流传输模式") + @ApiImplicitParams({ + @ApiImplicitParam(name = "deviceId", value = "设备id", required = true), + @ApiImplicitParam(name = "streamMode", value = "数据流传输模式, 取值：" + + "UDP（udp传输），TCP-ACTIVE（tcp主动模式,暂不支持），TCP-PASSIVE（tcp被动模式）"), + }) + @PostMapping("/transport/{deviceId}/{streamMode}") public ResponseEntity updateTransport(@PathVariable String deviceId, @PathVariable String streamMode){ Device device = storager.queryVideoDevice(deviceId); device.setStreamMode(streamMode); @@ -186,8 +271,12 @@ public class DeviceQuery { /** * 设备状态查询请求API接口 * - * @param deviceId + * @param deviceId 设备id */ + @ApiOperation("设备状态查询") + @ApiImplicitParams({ + @ApiImplicitParam(name = "deviceId", value = "设备id", required = true), + }) @GetMapping("/devices/{deviceId}/status") public DeferredResult> deviceStatusApi(@PathVariable String deviceId) { if (logger.isDebugEnabled()) { @@ -216,9 +305,25 @@ public class DeviceQuery { /** * 设备报警查询请求API接口 - * - * @param deviceId + * @param deviceId 设备id + * @param startPriority 报警起始级别（可选） + * @param endPriority 报警终止级别（可选） + * @param alarmMethod 报警方式条件（可选） + * @param alarmType 报警类型 + * @param startTime 报警发生起始时间（可选） + * @param endTime 报警发生终止时间（可选） + * @return true = 命令发送成功 */ + @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 = "报警发生终止时间"), + }) @GetMapping("/alarm/{deviceId}") public DeferredResult> alarmApi(@PathVariable String deviceId, @RequestParam(required = false) String startPriority, diff --git a/src/main/java/com/genersoft/iot/vmp/vmanager/gbStream/GbStreamController.java b/src/main/java/com/genersoft/iot/vmp/vmanager/gbStream/GbStreamController.java index 787a094c..c61b62f7 100644 --- a/src/main/java/com/genersoft/iot/vmp/vmanager/gbStream/GbStreamController.java +++ b/src/main/java/com/genersoft/iot/vmp/vmanager/gbStream/GbStreamController.java @@ -5,11 +5,16 @@ import com.genersoft.iot.vmp.storager.IVideoManagerStorager; import com.genersoft.iot.vmp.vmanager.gbStream.bean.GbStreamParam; import com.genersoft.iot.vmp.service.IGbStreamService; 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; import org.springframework.web.bind.annotation.*; +@Api(tags = "视频流关联到级联平台") @CrossOrigin @RestController @RequestMapping("/api/gbStream") @@ -24,7 +29,18 @@ public class GbStreamController { private IVideoManagerStorager storager; - @RequestMapping(value = "/list") + /** + * 查询国标通道 + * @param page 当前页 + * @param count 每页条数 + * @return + */ + @ApiOperation("查询国标通道") + @ApiImplicitParams({ + @ApiImplicitParam(name = "page", value = "当前页", required = true ), + @ApiImplicitParam(name = "count", value = "每页条数", required = true ), + }) + @GetMapping(value = "/list") @ResponseBody public PageInfo list(@RequestParam(required = false)Integer page, @RequestParam(required = false)Integer count){ @@ -33,11 +49,18 @@ public class GbStreamController { } - @RequestMapping(value = "/del") + /** + * 移除国标关联 + * @param gbStreamParam + * @return + */ + @ApiOperation("移除国标关联") + @ApiImplicitParams({ + @ApiImplicitParam(name = "gbStreamParam", value = "GbStreamParam", required = true ), + }) + @DeleteMapping(value = "/del") @ResponseBody public Object del(@RequestBody GbStreamParam gbStreamParam){ - System.out.println(2222); - System.out.println(gbStreamParam.getGbStreams().size()); if (gbStreamService.delPlatformInfo(gbStreamParam.getGbStreams())) { return "success"; }else { @@ -46,7 +69,17 @@ public class GbStreamController { } - @RequestMapping(value = "/add") + /** + * 保存国标关联 + * @param gbStreamParam + * @return + */ + @ApiOperation("保存国标关联") +// @ApiImplicitParams({ +// @ApiImplicitParam(name = "app", value = "视频流应用名", required = true ), +// @ApiImplicitParam(name = "gbId", value = "国标ID", required = true ), +// }) + @PostMapping(value = "/add") @ResponseBody public Object add(@RequestBody GbStreamParam gbStreamParam){ System.out.println(3333); diff --git a/src/main/java/com/genersoft/iot/vmp/vmanager/play/PlayController.java b/src/main/java/com/genersoft/iot/vmp/vmanager/play/PlayController.java index d104b85c..df16dd85 100644 --- a/src/main/java/com/genersoft/iot/vmp/vmanager/play/PlayController.java +++ b/src/main/java/com/genersoft/iot/vmp/vmanager/play/PlayController.java @@ -33,7 +33,7 @@ import javax.sip.message.Response; @CrossOrigin @RestController -@RequestMapping("/api") +@RequestMapping("/api/play") public class PlayController { private final static Logger logger = LoggerFactory.getLogger(PlayController.class); @@ -59,7 +59,7 @@ public class PlayController { @Autowired private IMediaService mediaService; - @GetMapping("/play/{deviceId}/{channelId}") + @GetMapping("/start/{deviceId}/{channelId}") public DeferredResult> play(@PathVariable String deviceId, @PathVariable String channelId) { @@ -79,7 +79,7 @@ public class PlayController { return playResult.getResult(); } - @PostMapping("/play/{streamId}/stop") + @PostMapping("/stop/{streamId}") public DeferredResult> playStop(@PathVariable String streamId) { logger.debug(String.format("设备预览/回放停止API调用，streamId：%s", streamId)); @@ -139,7 +139,7 @@ public class PlayController { * @param streamId 流ID * @return */ - @PostMapping("/play/{streamId}/convert") + @PostMapping("/convert/{streamId}") public ResponseEntity playConvert(@PathVariable String streamId) { StreamInfo streamInfo = redisCatchStorage.queryPlayByStreamId(streamId); if (streamInfo == null) { @@ -179,7 +179,7 @@ public class PlayController { * @param key * @return */ - @PostMapping("/play/convert/stop/{key}") + @PostMapping("/convertStop/{key}") public ResponseEntity playConvertStop(@PathVariable String key) { JSONObject jsonObject = zlmresTfulUtils.delFFmpegSource(key); diff --git a/src/main/java/com/genersoft/iot/vmp/vmanager/playback/PlaybackController.java b/src/main/java/com/genersoft/iot/vmp/vmanager/playback/PlaybackController.java index 9ce26728..e816562d 100644 --- a/src/main/java/com/genersoft/iot/vmp/vmanager/playback/PlaybackController.java +++ b/src/main/java/com/genersoft/iot/vmp/vmanager/playback/PlaybackController.java @@ -28,7 +28,7 @@ import java.util.UUID; @CrossOrigin @RestController -@RequestMapping("/api") +@RequestMapping("/api/playback") public class PlaybackController { private final static Logger logger = LoggerFactory.getLogger(PlaybackController.class); @@ -51,7 +51,7 @@ public class PlaybackController { @Autowired private DeferredResultHolder resultHolder; - @GetMapping("/playback/{deviceId}/{channelId}") + @GetMapping("/start/{deviceId}/{channelId}") public DeferredResult> play(@PathVariable String deviceId, @PathVariable String channelId, String startTime, String endTime) { @@ -89,7 +89,7 @@ public class PlaybackController { return result; } - @RequestMapping("/playback/{ssrc}/stop") + @RequestMapping("/stop/{ssrc}") public ResponseEntity playStop(@PathVariable String ssrc) { cmder.streamByeCmd(ssrc); diff --git a/src/main/resources/application-dev.yml b/src/main/resources/application-dev.yml index e45bfb59..d4abf207 100644 --- a/src/main/resources/application-dev.yml +++ b/src/main/resources/application-dev.yml @@ -96,4 +96,10 @@ logging: # [根据业务需求配置] userSettings: # 保存移动位置历史轨迹：true:保留历史数据，false:仅保留最后的位置(默认) - savePositionHistory: false \ No newline at end of file + savePositionHistory: false + +# 在线文档： swagger-ui（生产环境建议关闭） +springfox: + documentation: + swagger-ui: + enabled: true \ No newline at end of file diff --git a/web_src/src/components/DeviceList.vue b/web_src/src/components/DeviceList.vue index 8a3f1c0e..21e02aa2 100644 --- a/web_src/src/components/DeviceList.vue +++ b/web_src/src/components/DeviceList.vue @@ -136,7 +136,7 @@ getDeviceList: function() { let that = this; this.getDeviceListLoading = true; - this.$axios.get(`/api/devices`,{ + this.$axios.get(`/api/device/query/devices`,{ params: { page: that.currentPage, count: that.count @@ -167,13 +167,12 @@ //gb28181平台对接 //刷新设备信息 refDevice: function(itemData) { - ///api/devices/{deviceId}/sync console.log("刷新对应设备:" + itemData.deviceId); var that = this; that.$refs[itemData.deviceId + 'refbtn' ].loading = true; this.$axios({ method: 'post', - url: '/api/devices/' + itemData.deviceId + '/sync' + url: '/api/device/query/devices/' + itemData.deviceId + '/sync' }).then(function(res) { console.log("刷新设备结果："+JSON.stringify(res)); if (!res.data.deviceId) { @@ -217,7 +216,7 @@ let that = this; this.$axios({ method: 'get', - url: '/api/devices/' + row.deviceId + '/transport/' + row.streamMode + url: '/api/device/query/transport' + row.deviceId + '/' + row.streamMode }).then(function(res) { }).catch(function(e) { diff --git a/web_src/src/components/channelList.vue b/web_src/src/components/channelList.vue index b06ce258..ebb4318b 100644 --- a/web_src/src/components/channelList.vue +++ b/web_src/src/components/channelList.vue @@ -154,7 +154,7 @@ export default { getDeviceChannelList: function () { let that = this; - this.$axios.get(`/api/devices/${this.$route.params.deviceId}/channels`, { + this.$axios.get(`/api/device/query/devices/${this.$route.params.deviceId}/channels`, { params: { page: that.currentPage, count: that.count, @@ -188,7 +188,7 @@ export default { let that = this; this.$axios({ method: 'get', - url: '/api/play/' + deviceId + '/' + channelId + url: '/api/play/start/' + deviceId + '/' + channelId }).then(function (res) { console.log(res.data) let streamId = res.data.streamId; @@ -216,7 +216,7 @@ export default { var that = this; this.$axios({ method: 'post', - url: '/api/play/' + itemData.streamId + '/stop' + url: '/api/play/stop/' + itemData.streamId }).then(function (res) { console.log(JSON.stringify(res)); that.initData(); @@ -251,7 +251,7 @@ export default { showSubchannels: function (channelId) { let that = this; - this.$axios.get(`/api/subChannels/${this.deviceId}/${this.parentChannelId}/channels`, { + this.$axios.get(`/api/device/query/sub_channels/${this.deviceId}/${this.parentChannelId}/channels`, { params: { page: that.currentPage, count: that.count, @@ -282,7 +282,7 @@ export default { console.log(row) this.$axios({ method: 'post', - url: `/api/channel/update/${this.deviceId}`, + url: `/api/device/query/channel/update/${this.deviceId}`, params: row }).then(function (res) { console.log(JSON.stringify(res)); diff --git a/web_src/src/components/dialog/devicePlayer.vue b/web_src/src/components/dialog/devicePlayer.vue index 67800955..2c5aa57d 100644 --- a/web_src/src/components/dialog/devicePlayer.vue +++ b/web_src/src/components/dialog/devicePlayer.vue @@ -261,7 +261,7 @@ export default { this.$refs.videoPlayer.pause() that.$axios({ method: 'post', - url: '/api/play/' + that.streamId + '/convert' + url: '/api/play/convert/' + that.streamId }).then(function (res) { if (res.data.code == 0) { that.convertKey = res.data.key; @@ -298,7 +298,7 @@ export default { that.$refs.videoPlayer.pause() this.$axios({ method: 'post', - url: '/api/play/convert/stop/' + this.convertKey + url: '/api/play/convertStop/' + this.convertKey }).then(function (res) { if (res.data.code == 0) { console.log(res.data.msg) @@ -393,7 +393,7 @@ export default { } else { this.$axios({ method: 'get', - url: '/api/playback/' + this.deviceId + '/' + this.channelId + '?startTime=' + row.startTime + '&endTime=' + + url: '/api/playback/start/' + this.deviceId + '/' + this.channelId + '?startTime=' + row.startTime + '&endTime=' + row.endTime }).then(function (res) { var streamInfo = res.data; @@ -408,7 +408,7 @@ export default { this.videoUrl = ''; this.$axios({ method: 'get', - url: '/api/playback/' + this.streamId + '/stop' + url: '/api/playback/stop/' + this.streamId }).then(function (res) { if (callback) callback() });