规范化api，进行中。。。

2021-04-09 17:59:38 +08:00
parent 2310087e03
commit f10a9238dc
12 changed files with 113 additions and 43 deletions
--- a/src/main/java/com/genersoft/iot/vmp/vmanager/MobilePosition/MobilePositionController.java
+++ b/src/main/java/com/genersoft/iot/vmp/vmanager/MobilePosition/MobilePositionController.java
@@ -12,6 +12,10 @@ import com.genersoft.iot.vmp.gb28181.transmit.cmd.impl.SIPCommander;
 import com.genersoft.iot.vmp.storager.IVideoManagerStorager;
 import com.github.pagehelper.util.StringUtil;

+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,13 @@ import org.springframework.web.bind.annotation.RequestParam;
 import org.springframework.web.bind.annotation.RestController;
 import org.springframework.web.context.request.async.DeferredResult;

+/**
+ *  位置信息管理
+ */
+@Api(tags = "位置信息管理")
@CrossOrigin
@RestController
-@RequestMapping("/api")
+@RequestMapping("/api/position")
 public class MobilePositionController {

    private final static Logger logger = LoggerFactory.getLogger(MobilePositionController.class);
@@ -40,8 +48,21 @@ public class MobilePositionController {
 	
 	@Autowired
 	private DeferredResultHolder resultHolder;
-	
-    @GetMapping("/positions/{deviceId}/history")
+
+    /**
+     *  查询历史轨迹
+     * @param deviceId 设备ID
+     * @param start 开始时间
+     * @param end 结束时间
+     * @return
+     */
+    @ApiOperation("查询历史轨迹")
+    @ApiImplicitParams({
+            @ApiImplicitParam(name = "deviceId", value = "设备ID", required = true),
+            @ApiImplicitParam(name = "start", value = "开始时间", required = true),
+            @ApiImplicitParam(name = "end", value = "结束时间", required = true),
+    })
+    @GetMapping("/history/{deviceId}")
    public ResponseEntity<List<MobilePosition>> positions(@PathVariable String deviceId,
                                                    @RequestParam(required = false) String start,
                                                    @RequestParam(required = false) String end) {
@@ -60,7 +81,16 @@ public class MobilePositionController {
        return new ResponseEntity<>(result, HttpStatus.OK);
    }

-    @GetMapping("/positions/{deviceId}/latest")
+    /**
+     *  查询设备最新位置
+     * @param deviceId 设备ID
+     * @return
+     */
+    @ApiOperation("查询设备最新位置")
+    @ApiImplicitParams({
+            @ApiImplicitParam(name = "deviceId", value = "设备ID", required = true),
+    })
+    @GetMapping("/latest/{deviceId}")
    public ResponseEntity<MobilePosition> latestPosition(@PathVariable String deviceId) {
        if (logger.isDebugEnabled()) {
            logger.debug("查询设备" + deviceId + "的最新位置");
@@ -69,7 +99,16 @@ public class MobilePositionController {
        return new ResponseEntity<>(result, HttpStatus.OK);
    }

-    @GetMapping("/positions/{deviceId}/realtime")
+    /**
+     *  获取移动位置信息
+     * @param deviceId 设备ID
+     * @return
+     */
+    @ApiOperation("获取移动位置信息")
+    @ApiImplicitParams({
+            @ApiImplicitParam(name = "deviceId", value = "设备ID", required = true),
+    })
+    @GetMapping("/realtime/{deviceId}")
    public DeferredResult<ResponseEntity<MobilePosition>> realTimePosition(@PathVariable String deviceId) {
        Device device = storager.queryVideoDevice(deviceId);
        cmder.mobilePostitionQuery(device, event -> {
@@ -92,7 +131,20 @@ public class MobilePositionController {
        return result;
    }

-    @GetMapping("/positions/{deviceId}/subscribe")
+    /**
+     * 订阅位置信息
+     * @param deviceId 设备ID
+     * @param expires 订阅超时时间
+     * @param interval 上报时间间隔
+     * @return true = 命令发送成功
+     */
+    @ApiOperation("订阅位置信息")
+    @ApiImplicitParams({
+            @ApiImplicitParam(name = "deviceId", value = "设备ID", required = true),
+            @ApiImplicitParam(name = "expires", value = "订阅超时时间"),
+            @ApiImplicitParam(name = "interval", value = "上报时间间隔"),
+    })
+    @GetMapping("/subscribe/{deviceId}")
    public ResponseEntity<String> positionSubscribe(@PathVariable String deviceId,
                                                    @RequestParam String expires,
                                                    @RequestParam String interval) {
--- a/src/main/java/com/genersoft/iot/vmp/vmanager/gbStream/GbStreamController.java
+++ b/src/main/java/com/genersoft/iot/vmp/vmanager/gbStream/GbStreamController.java
@@ -75,15 +75,12 @@ public class GbStreamController {
     * @return
     */
    @ApiOperation("保存国标关联")
-//    @ApiImplicitParams({
-//            @ApiImplicitParam(name = "app", value = "视频流应用名", required = true ),
-//            @ApiImplicitParam(name = "gbId", value = "国标ID", required = true ),
-//    })
+    @ApiImplicitParams({
+            @ApiImplicitParam(name = "gbStreamParam", value = "GbStreamParam", required = true ),
+    })
    @PostMapping(value = "/add")
    @ResponseBody
    public Object add(@RequestBody GbStreamParam gbStreamParam){
-        System.out.println(3333);
-        System.out.println(gbStreamParam.getGbStreams().size());
        if (gbStreamService.addPlatformInfo(gbStreamParam.getGbStreams(), gbStreamParam.getPlatformId())) {
            return "success";
        }else {
--- a/src/main/java/com/genersoft/iot/vmp/vmanager/media/MediaController.java
+++ b/src/main/java/com/genersoft/iot/vmp/vmanager/media/MediaController.java
@@ -9,6 +9,10 @@ import com.genersoft.iot.vmp.storager.IRedisCatchStorage;
 import com.genersoft.iot.vmp.service.IMediaService;
 import com.genersoft.iot.vmp.service.IStreamProxyService;
 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;
@@ -16,6 +20,7 @@ import org.springframework.stereotype.Controller;
 import org.springframework.web.bind.annotation.*;


+@Api(tags = "媒体流相关")
@Controller
@CrossOrigin
@RequestMapping(value = "/api/media")
@@ -33,8 +38,17 @@ public class MediaController {
    private IMediaService mediaService;


-
-
+    /**
+     * 根据应用名和流id获取播放地址
+     * @param app 应用名
+     * @param stream 流id
+     * @return
+     */
+    @ApiOperation("根据应用名和流id获取播放地址")
+    @ApiImplicitParams({
+            @ApiImplicitParam(name = "app", value = "应用名"),
+            @ApiImplicitParam(name = "stream", value = "流id"),
+    })
    @RequestMapping(value = "/getStreamInfoByAppAndStream")
    @ResponseBody
    public StreamInfo getStreamInfoByAppAndStream(String app, String stream){
--- a/src/main/java/com/genersoft/iot/vmp/vmanager/platform/PlatformController.java
+++ b/src/main/java/com/genersoft/iot/vmp/vmanager/platform/PlatformController.java
@@ -8,6 +8,7 @@ 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.github.pagehelper.PageInfo;
+import io.swagger.annotations.Api;
 import org.slf4j.Logger;
 import org.slf4j.LoggerFactory;
 import org.springframework.beans.factory.annotation.Autowired;
@@ -17,9 +18,13 @@ import org.springframework.util.StringUtils;
 import org.springframework.web.bind.annotation.*;
 import com.genersoft.iot.vmp.conf.SipConfig;

+/**
+ * 级联平台管理
+ */
+@Api("级联平台管理")
@CrossOrigin
@RestController
-@RequestMapping("/api")
+@RequestMapping("/api/platform")
 public class PlatformController {

    private final static Logger logger = LoggerFactory.getLogger(PlatformController.class);
@@ -36,7 +41,7 @@ public class PlatformController {
 	@Autowired
 	private SipConfig sipConfig;

-    @GetMapping("/platforms/serverconfig")
+    @GetMapping("/server_config")
    public ResponseEntity<JSONObject> serverConfig() {
        JSONObject result = new JSONObject();
        result.put("deviceIp", sipConfig.getSipIp());
@@ -46,7 +51,7 @@ public class PlatformController {
        return new ResponseEntity<>(result, HttpStatus.OK);
    }

-    @GetMapping("/platforms/{count}/{page}")
+    @GetMapping("/query/{count}/{page}")
    public PageInfo<ParentPlatform> platforms(@PathVariable int page, @PathVariable int count){

        if (logger.isDebugEnabled()) {
@@ -55,7 +60,7 @@ public class PlatformController {
        return storager.queryParentPlatformList(page, count);
    }

-    @RequestMapping("/platforms/save")
+    @PostMapping("/save")
    @ResponseBody
    public ResponseEntity<String> savePlatform(@RequestBody ParentPlatform parentPlatform){

@@ -98,18 +103,19 @@ public class PlatformController {
        }
    }

-    @RequestMapping("/platforms/delete")
+    @DeleteMapping("/delete/{serverGBId}")
    @ResponseBody
-    public ResponseEntity<String> deletePlatform(@RequestBody ParentPlatform parentPlatform){
+    public ResponseEntity<String> deletePlatform(@PathVariable String serverGBId){

        if (logger.isDebugEnabled()) {
            logger.debug("删除上级平台API调用");
        }
-        if (StringUtils.isEmpty(parentPlatform.getServerGBId())
+        if (StringUtils.isEmpty(serverGBId)
        ){
            return new ResponseEntity<>("missing parameters", HttpStatus.BAD_REQUEST);
        }
-
+        ParentPlatform parentPlatform = storager.queryParentPlatById(serverGBId);
+        if (parentPlatform == null) return new ResponseEntity<>("fail", HttpStatus.OK);
        // 发送离线消息,无论是否成功都删除缓存
        commanderForPlatform.unregister(parentPlatform, (event -> {
            // 清空redis缓存
@@ -133,7 +139,7 @@ public class PlatformController {
        }
    }

-    @RequestMapping("/platforms/exit/{deviceGbId}")
+    @GetMapping("/exit/{deviceGbId}")
    @ResponseBody
    public ResponseEntity<String> exitPlatform(@PathVariable String deviceGbId){

@@ -144,7 +150,7 @@ public class PlatformController {
        return new ResponseEntity<>(String.valueOf(parentPlatform != null), HttpStatus.OK);
    }

-    @RequestMapping("/platforms/channelList")
+    @GetMapping("/channel_list")
    @ResponseBody
    public PageInfo<ChannelReduce> channelList(int page, int count,
                                              @RequestParam(required = false) String platformId,
@@ -167,7 +173,7 @@ public class PlatformController {
    }


-    @RequestMapping("/platforms/updateChannelForGB")
+    @PostMapping("/update_channel_for_gb")
    @ResponseBody
    public ResponseEntity<String> updateChannelForGB(@RequestBody UpdateChannelParam param){

@@ -179,7 +185,7 @@ public class PlatformController {
        return new ResponseEntity<>(String.valueOf(result > 0), HttpStatus.OK);
    }

-    @RequestMapping("/platforms/delChannelForGB")
+    @DeleteMapping("/del_channel_for_gb")
    @ResponseBody
    public ResponseEntity<String> delChannelForGB(@RequestBody UpdateChannelParam param){