视频接口增加到文档中

zc-business/src/main/java/com/zc/business/controller/VideoController.java

@@ -7,6 +7,9 @@ import com.ruoyi.common.core.domain.AjaxResult;
 import com.zc.common.core.httpclient.OkHttp;
 import com.zc.common.core.httpclient.exception.HttpException;
 import com.zc.common.core.httpclient.request.RequestParams;
+import io.swagger.annotations.Api;
+import io.swagger.annotations.ApiOperation;
+import io.swagger.annotations.ApiParam;
 import okhttp3.Response;
 import org.springframework.web.bind.annotation.GetMapping;
 import org.springframework.web.bind.annotation.RequestMapping;
@@ -26,6 +29,7 @@ import static com.ruoyi.common.constant.Constants.HTTP;
  *
  * @author Athena-xiepufeng
  */
+@Api(tags = "视频接口")
 @RestController
 @RequestMapping("/video")
 public class VideoController extends BaseController {
@@ -44,8 +48,10 @@ public class VideoController extends BaseController {
     /**
      * 查询附近相机
      */
+    @ApiOperation("查询附近相机")
     @GetMapping(value = "/nearCamListDistance")
-    public JSONObject nearCamListDistance(String devLat, String devLon) throws HttpException, IOException {
+    public JSONObject nearCamListDistance(@ApiParam(value = "纬度", name = "devLat",required = true)String devLat,
+                                          @ApiParam(value = "经度", name = "devLon",required = true)String devLon) throws HttpException, IOException {
 
         JSONObject jsonResult = null;
 
@@ -93,8 +99,9 @@ public class VideoController extends BaseController {
     /**
      * 根据桩号查询附近相机
      */
+    @ApiOperation("根据桩号查询附近相机")
     @GetMapping(value = "/nearCamListPileNum")
-    public Object nearCamListPileNum(String pileNum) throws HttpException, IOException {
+    public Object nearCamListPileNum(@ApiParam(value = "桩号", name = "pileNum", required = true) String pileNum) throws HttpException, IOException {
 
         // 获取济菏运管中心相机信息
         JSONObject camInfo = getCamByDept("1301730");
@@ -120,8 +127,9 @@ public class VideoController extends BaseController {
     /**
      * 获取视频流信息
      */
+    @ApiOperation("获取视频流信息")
     @GetMapping(value = "/externalVideoStreaming")
-    public JSONObject externalVideoStreaming(String camId) throws HttpException, IOException {
+    public JSONObject externalVideoStreaming(@ApiParam(value = "摄像头标识", name = "camId", required = true) String camId) throws HttpException, IOException {
 
         JSONObject jsonResult = null;
 
@@ -165,8 +173,11 @@ public class VideoController extends BaseController {
     /**
      * 云平台控制
      */
+    @ApiOperation("云平台控制")
     @GetMapping(value = "/PTZControl")
-    public JSONObject PTZControl(String camId, String cmdType, String speed) throws HttpException, IOException {
+    public JSONObject PTZControl(@ApiParam(value = "相机id", name = "camId", required = true) String camId,
+                                 @ApiParam(value = "相机类型", name = "cmdType", required = true) String cmdType,
+                                 @ApiParam(value = "速度", name = "speed", required = true) String speed) throws HttpException, IOException {
 
         JSONObject jsonResult = null;
 
@@ -234,6 +245,7 @@ public class VideoController extends BaseController {
 
     /**
      * 根据组织机构获取摄像机信息
+     *
      * @param deptId 机构id
      * @return
      */
@@ -276,6 +288,7 @@ public class VideoController extends BaseController {
 
     /**
      * 判断是否是附近桩号
+     *
      * @return
      */
     private boolean isNearbyPileNum(String centralPileNum, String nearbyPileNum) {
@@ -289,6 +302,7 @@ public class VideoController extends BaseController {
 
     /**
      * 转换转换成米
+     *
      * @param pileNum 桩号
      * @return
      */