更新 webapi 的 swagger 注释

mgr/src/main/java/cn/reghao/devops/mgr/admin/account/controller/AccountCodeController.java

@@ -4,6 +4,8 @@ import cn.reghao.devops.mgr.admin.account.model.dto.RsaPubkey;
 import cn.reghao.devops.mgr.admin.account.service.CodeService;
 import cn.reghao.devops.mgr.admin.account.service.PubkeyService;
 import cn.reghao.jutil.jdk.result.WebResult;
+import io.swagger.annotations.Api;
+import io.swagger.annotations.ApiOperation;
 import org.springframework.http.MediaType;
 import org.springframework.web.bind.annotation.GetMapping;
 import org.springframework.web.bind.annotation.RequestMapping;
@@ -19,6 +21,7 @@ import java.util.Base64;
  * @author reghao
  * @date 2022-02-18 16:05:30
  */
+@Api(tags = "验证码接口")
 @RestController
 @RequestMapping("/api/account/code")
 public class AccountCodeController {
@@ -30,12 +33,14 @@ public class AccountCodeController {
         this.pubkeyService = pubkeyService;
     }
 
+    @ApiOperation(value = "获取公钥")
     @GetMapping(value = "/pubkey", produces = MediaType.APPLICATION_JSON_VALUE)
     public String getPubkey() throws NoSuchAlgorithmException {
         RsaPubkey rsaPubkey = pubkeyService.getPubkey();
         return WebResult.success(rsaPubkey);
     }
 
+    @ApiOperation(value = "获取图形验证码")
     @GetMapping(value = "/captcha", produces = MediaType.APPLICATION_JSON_VALUE)
     public String getCaptcha() throws IOException {
         InputStream in = codeService.generateCaptcha();

mgr/src/main/java/cn/reghao/devops/mgr/app/HomeController.java

@@ -14,6 +14,7 @@ import cn.reghao.jutil.jdk.jvm.JVM;
 import cn.reghao.jutil.jdk.jvm.model.JvmInfo;
 import cn.reghao.jutil.jdk.machine.id.MachineIdLinux;
 import io.swagger.annotations.Api;
+import io.swagger.annotations.ApiOperation;
 import lombok.extern.slf4j.Slf4j;
 import org.springframework.stereotype.Controller;
 import org.springframework.ui.Model;
@@ -48,12 +49,14 @@ public class HomeController {
         this.machineQuery = machineQuery;
     }
 
+    @ApiOperation(value = "帐号登入页面")
     @GetMapping("/login")
     public String toLogin(Model model) {
         model.addAttribute("isCaptcha", false);
         return "/login";
     }
 
+    @ApiOperation(value = "系统主页面")
     @GetMapping("/")
     public String index(Model model) throws Exception {
         User user = UserContext.getUser();
@@ -75,6 +78,7 @@ public class HomeController {
         return "/main";
     }
 
+    @ApiOperation(value = "系统 home 页面")
     @GetMapping("/home")
     public String home(Model model) {
         String commitId = NotAvailable.na.getDesc();

mgr/src/main/java/cn/reghao/devops/mgr/mgr/app/controller/GetAppController.java

@@ -2,6 +2,7 @@ package cn.reghao.devops.mgr.mgr.app.controller;
 
 import cn.reghao.devops.mgr.mgr.app.service.bd.GetApp;
 import cn.reghao.jutil.jdk.result.WebResult;
+import io.swagger.annotations.Api;
 import io.swagger.annotations.ApiOperation;
 import lombok.extern.slf4j.Slf4j;
 import org.springframework.http.MediaType;
@@ -15,6 +16,7 @@ import org.springframework.web.bind.annotation.ResponseBody;
  * @author reghao
  * @date 2023-04-21 23:57:00
  */
+@Api(tags = "构建包接口")
 @Slf4j
 @Controller
 @RequestMapping("/api/app/bd")

mgr/src/main/java/cn/reghao/devops/mgr/mgr/app/controller/page/AppConfigPageController.java

@@ -48,7 +48,7 @@ public class AppConfigPageController {
         this.packerConfigRepository = packerConfigRepository;
     }
 
-    @ApiOperation(value = "应用配置页面")
+    @ApiOperation(value = "应用配置列表页面")
     @GetMapping
     public String appConfigPage(@RequestParam(value = "env", required = false) String env,
                                 @RequestParam(value = "type", required = false) String type,
@@ -84,6 +84,7 @@ public class AppConfigPageController {
         return "/devops/app/config/index";
     }
 
+    @ApiOperation(value = "添加应用配置页面")
     @GetMapping("/add")
     public String addAppConfigPage(Model model) {
         setAppModel(model);
@@ -126,6 +127,7 @@ public class AppConfigPageController {
         model.addAttribute("packers", packers);
     }
 
+    @ApiOperation(value = "编辑应用配置页面")
     @GetMapping("/edit/{id}")
     public String editAppConfigPage(@PathVariable("id") AppConfig app, Model model) {
         setAppModel(model);
@@ -133,6 +135,7 @@ public class AppConfigPageController {
         return "/devops/app/config/edit";
     }
 
+    @ApiOperation(value = "拷贝应用配置页面")
     @GetMapping("/copy/{appId}")
     public String copyAppConfigPage(@PathVariable("appId") String appId, Model model) {
         List<KeyValue> envs = getEnvList();
@@ -150,6 +153,7 @@ public class AppConfigPageController {
         return envs;
     }
 
+    @ApiOperation(value = "应用配置详情页面")
     @GetMapping("/detail/{appId}")
     public String appConfigPage(@PathVariable("appId") String appId, Model model) {
         AppConfig app = appBuildQuery.getAppConfig(appId);

mgr/src/main/java/cn/reghao/devops/mgr/mgr/app/controller/page/AppDeployConfigPageController.java

@@ -63,6 +63,7 @@ public class AppDeployConfigPageController {
         return "/devops/app/deploy/add";
     }
 
+    @ApiOperation(value = "编辑部署配置页面")
     @GetMapping("/edit/{appId}/{machineId}")
     public String editAppConfigPage(@PathVariable("appId") String appId,
                                     @PathVariable("machineId") String machineId,
@@ -72,6 +73,7 @@ public class AppDeployConfigPageController {
         return "/devops/app/deploy/edit";
     }
 
+    @ApiOperation(value = "部署配置详情页面")
     @GetMapping("/detail/{appId}/{machineId}")
     public String appConfigPage(@PathVariable("appId") String appId, @PathVariable("machineId") String machineId,
                                 Model model) {

mgr/src/main/java/cn/reghao/devops/mgr/mgr/builds/controller/page/BuildDirPageController.java

@@ -47,7 +47,7 @@ public class BuildDirPageController {
         return "/devops/build/builddir";
     }
 
-    @ApiOperation(value = "目录容量详情页面")
+    @ApiOperation(value = "构建目录所在磁盘容量详情页面")
     @PreAuthorize("hasRole('ROLE_ADMIN')")
     @GetMapping("/usage")
     public String usagePage(Model model) {

mgr/src/main/java/cn/reghao/devops/mgr/mgr/log/controller/AppLogController.java

@@ -2,6 +2,7 @@ package cn.reghao.devops.mgr.mgr.log.controller;
 
 import cn.reghao.devops.mgr.mgr.log.service.LoggingService;
 import cn.reghao.jutil.jdk.result.WebResult;
+import io.swagger.annotations.Api;
 import io.swagger.annotations.ApiOperation;
 import org.springframework.http.MediaType;
 import org.springframework.stereotype.Controller;
@@ -15,6 +16,7 @@ import java.util.List;
  * @author reghao
  * @date 2023-11-02 13:39:54
  */
+@Api(tags = "日志接口")
 @Controller
 public class AppLogController {
     private final LoggingService loggingService;
@@ -41,6 +43,7 @@ public class AppLogController {
         return "/devops/app/stat/nginxlog";
     }
 
+    @ApiOperation(value = "Nginx 日志的 echarts 数据")
     @GetMapping(value = "/api/log/nginx/chart", produces = MediaType.APPLICATION_JSON_VALUE)
     @ResponseBody
     public String nginxLogData() throws ParseException {