diff --git a/manager/src/main/java/com/usthe/manager/config/SwaggerConfig.java b/manager/src/main/java/com/usthe/manager/config/SwaggerConfig.java index 4d2b35b..891b06e 100644 --- a/manager/src/main/java/com/usthe/manager/config/SwaggerConfig.java +++ b/manager/src/main/java/com/usthe/manager/config/SwaggerConfig.java @@ -6,7 +6,6 @@ import springfox.documentation.builders.PathSelectors; import springfox.documentation.builders.RequestHandlerSelectors; import springfox.documentation.oas.annotations.EnableOpenApi; import springfox.documentation.service.ApiInfo; -import springfox.documentation.service.Contact; import springfox.documentation.spi.DocumentationType; import springfox.documentation.spring.web.plugins.Docket; @@ -27,20 +26,20 @@ public class SwaggerConfig { return new Docket(DocumentationType.OAS_30) .apiInfo(apiInfo()) .enable(true) - .groupName("usthe.com") + .groupName("TanCloud") .select() .apis(RequestHandlerSelectors.any()) - .paths(PathSelectors.any()) + .paths(PathSelectors.regex("(?!/error.*).*")) .build(); } private ApiInfo apiInfo(){ return new ApiInfo( - "usthe api", - "monitor project", + "TanCloud", + null, "v1.0", - "usthe.com", - new Contact("tom", "usthe.com", "tomsun28@outlook.com"), + null, + null, "Apache 2.0", "http://www.apache.org/licenses/LICENSE-2.0", Collections.emptyList()); diff --git a/manager/src/main/java/com/usthe/manager/controller/AppController.java b/manager/src/main/java/com/usthe/manager/controller/AppController.java index e4b8ee9..b488ba4 100644 --- a/manager/src/main/java/com/usthe/manager/controller/AppController.java +++ b/manager/src/main/java/com/usthe/manager/controller/AppController.java @@ -5,6 +5,7 @@ import com.usthe.manager.pojo.entity.ParamDefine; import com.usthe.manager.service.AppService; import io.swagger.annotations.Api; import io.swagger.annotations.ApiOperation; +import io.swagger.annotations.ApiParam; import org.springframework.beans.factory.annotation.Autowired; import org.springframework.http.ResponseEntity; import org.springframework.web.bind.annotation.GetMapping; @@ -31,7 +32,8 @@ public class AppController { @GetMapping(path = "/{app}/params") @ApiOperation(value = "查询监控类型的参数结构", notes = "根据app查询指定监控类型的需要输入参数的结构") - public ResponseEntity>> queryAppParamDefines(@PathVariable("app") String app) { + public ResponseEntity>> queryAppParamDefines( + @ApiParam(value = "监控类型名称", example = "api") @PathVariable("app") String app) { List paramDefines = appService.getAppParamDefines(app); return ResponseEntity.ok(new Message<>(paramDefines)); } diff --git a/manager/src/main/java/com/usthe/manager/controller/MonitorController.java b/manager/src/main/java/com/usthe/manager/controller/MonitorController.java index c193163..6191058 100644 --- a/manager/src/main/java/com/usthe/manager/controller/MonitorController.java +++ b/manager/src/main/java/com/usthe/manager/controller/MonitorController.java @@ -5,6 +5,7 @@ import com.usthe.manager.pojo.dto.MonitorDto; import com.usthe.manager.service.MonitorService; import io.swagger.annotations.Api; import io.swagger.annotations.ApiOperation; +import io.swagger.annotations.ApiParam; import org.springframework.beans.factory.annotation.Autowired; import org.springframework.http.ResponseEntity; import org.springframework.web.bind.annotation.DeleteMapping; @@ -62,7 +63,8 @@ public class MonitorController { @GetMapping(path = "/{id}") @ApiOperation(value = "查询监控", notes = "根据监控ID获取监控信息") - public ResponseEntity> getMonitor(@PathVariable("id") long id) { + public ResponseEntity> getMonitor( + @ApiParam(value = "监控ID", example = "6565463543") @PathVariable("id") long id) { // 获取监控信息 MonitorDto monitorDto = monitorService.getMonitor(id); Message.MessageBuilder messageBuilder = Message.builder(); @@ -76,7 +78,8 @@ public class MonitorController { @DeleteMapping(path = "/{id}") @ApiOperation(value = "删除监控", notes = "根据监控ID删除监控应用,监控不存在也是删除成功") - public ResponseEntity> deleteMonitor(@PathVariable("id") long id) { + public ResponseEntity> deleteMonitor( + @ApiParam(value = "监控ID", example = "6565463543") @PathVariable("id") long id) { // 删除监控,监控不存在或删除成功都返回成功 monitorService.deleteMonitor(id); return ResponseEntity.ok(new Message<>("Delete success"));