From 0ad8974666f184a90b63f4cde84b7ad7514547dc Mon Sep 17 00:00:00 2001 From: skyouc Date: 星期三, 19 二月 2025 17:11:16 +0800 Subject: [PATCH] #修改 接口界面功能优化 --- rsf-server/src/main/java/com/vincent/rsf/server/manager/entity/MatnrGroup.java | 2 +- rsf-server/src/main/java/com/vincent/rsf/server/common/config/SwaggerConfig.java | 36 +++++++++++++++++++++++++++++++----- rsf-server/src/main/java/com/vincent/rsf/server/manager/controller/MatnrController.java | 6 ++++-- rsf-server/src/main/java/com/vincent/rsf/server/manager/entity/Shipper.java | 2 +- rsf-server/src/main/java/com/vincent/rsf/server/manager/entity/Warehouse.java | 1 + 5 files changed, 38 insertions(+), 9 deletions(-) diff --git a/rsf-server/src/main/java/com/vincent/rsf/server/common/config/SwaggerConfig.java b/rsf-server/src/main/java/com/vincent/rsf/server/common/config/SwaggerConfig.java index 65dedf4..e226de9 100644 --- a/rsf-server/src/main/java/com/vincent/rsf/server/common/config/SwaggerConfig.java +++ b/rsf-server/src/main/java/com/vincent/rsf/server/common/config/SwaggerConfig.java @@ -9,17 +9,17 @@ import org.springframework.context.annotation.Configuration; import org.springframework.util.ReflectionUtils; import org.springframework.web.servlet.mvc.method.RequestMappingInfoHandlerMapping; -import springfox.documentation.builders.ApiInfoBuilder; -import springfox.documentation.builders.PathSelectors; -import springfox.documentation.builders.RequestHandlerSelectors; +import springfox.documentation.builders.*; import springfox.documentation.oas.annotations.EnableOpenApi; -import springfox.documentation.service.ApiInfo; +import springfox.documentation.schema.ScalarType; +import springfox.documentation.service.*; import springfox.documentation.spi.DocumentationType; import springfox.documentation.spring.web.plugins.Docket; import springfox.documentation.spring.web.plugins.WebFluxRequestHandlerProvider; import springfox.documentation.spring.web.plugins.WebMvcRequestHandlerProvider; import java.lang.reflect.Field; +import java.util.ArrayList; import java.util.List; import java.util.stream.Collectors; @@ -42,7 +42,11 @@ //apis锛� 娣诲姞swagger鎺ュ彛鎻愬彇鑼冨洿 .apis(RequestHandlerSelectors.withClassAnnotation(Api.class)) .paths(PathSelectors.any()) - .build(); + .build() +// .globalRequestParameters(getGlobalRequestParameters()) +// .globalResponses(HttpMethod.GET, getGlobalResonseMessage()) +// .globalResponses(HttpMethod.POST, getGlobalResonseMessage()) + ; return docket; } @@ -55,6 +59,28 @@ .build(); } + //鐢熸垚鍏ㄥ眬閫氱敤鍙傛暟 + private List<RequestParameter> getGlobalRequestParameters() { + List<RequestParameter> parameters = new ArrayList<>(); + parameters.add(new RequestParameterBuilder() + .name("Authorization") + .description("鎺堟潈Token") + .required(true) + .in(ParameterType.QUERY) + .query(q -> q.model(m -> m.scalarModel(ScalarType.STRING))) + .required(false) + .build()); + return parameters; + } + + //鐢熸垚閫氱敤鍝嶅簲淇℃伅 + private List<Response> getGlobalResonseMessage() { + List<Response> responseList = new ArrayList<>(); + responseList.add(new ResponseBuilder().code("430").description("please login first").build()); + return responseList; + } + + @Bean public static BeanPostProcessor springfoxHandlerProviderBeanPostProcessor() { return new BeanPostProcessor() { diff --git a/rsf-server/src/main/java/com/vincent/rsf/server/manager/controller/MatnrController.java b/rsf-server/src/main/java/com/vincent/rsf/server/manager/controller/MatnrController.java index 4aecd2a..3e54623 100644 --- a/rsf-server/src/main/java/com/vincent/rsf/server/manager/controller/MatnrController.java +++ b/rsf-server/src/main/java/com/vincent/rsf/server/manager/controller/MatnrController.java @@ -15,14 +15,16 @@ import com.vincent.rsf.server.manager.service.MatnrService; import com.vincent.rsf.server.system.controller.BaseController; import io.swagger.annotations.Api; +import io.swagger.v3.oas.annotations.security.SecurityRequirement; import org.springframework.beans.factory.annotation.Autowired; +import org.springframework.http.HttpHeaders; import org.springframework.security.access.prepost.PreAuthorize; import org.springframework.web.bind.annotation.*; import javax.servlet.http.HttpServletResponse; import java.util.*; -@Api(tags = "鐗╂枡琛ㄦ帴鍙�") @RestController +@Api(tags = "鐗╂枡琛ㄦ帴鍙�") public class MatnrController extends BaseController { @Autowired @@ -104,7 +106,7 @@ return R.ok().add(vos); } - + @SecurityRequirement(name = HttpHeaders.AUTHORIZATION) @PreAuthorize("hasAuthority('manager:matnr:list')") @PostMapping("/matnr/group") public R getGroupMatnrs(@RequestBody Map<String, Object> map) { diff --git a/rsf-server/src/main/java/com/vincent/rsf/server/manager/entity/MatnrGroup.java b/rsf-server/src/main/java/com/vincent/rsf/server/manager/entity/MatnrGroup.java index 87deb71..acb2845 100644 --- a/rsf-server/src/main/java/com/vincent/rsf/server/manager/entity/MatnrGroup.java +++ b/rsf-server/src/main/java/com/vincent/rsf/server/manager/entity/MatnrGroup.java @@ -21,8 +21,8 @@ import java.util.List; @Data -@ApiModel(value = "鐗╂枡绫�") @TableName("man_matnr_group") +@ApiModel(value = "MatnrGroup", description = "鐗╂枡鍒嗙被淇℃伅") public class MatnrGroup implements Serializable { private static final long serialVersionUID = 1L; diff --git a/rsf-server/src/main/java/com/vincent/rsf/server/manager/entity/Shipper.java b/rsf-server/src/main/java/com/vincent/rsf/server/manager/entity/Shipper.java index 5720fdd..52dd313 100644 --- a/rsf-server/src/main/java/com/vincent/rsf/server/manager/entity/Shipper.java +++ b/rsf-server/src/main/java/com/vincent/rsf/server/manager/entity/Shipper.java @@ -22,8 +22,8 @@ import java.util.Date; @Data -@ApiModel(value = "璐т富鍩虹灞炴��") @TableName("man_shipper") +@ApiModel(value = "Shipper", description = "璐т富鍩虹淇℃伅") public class Shipper implements Serializable { private static final long serialVersionUID = 1L; diff --git a/rsf-server/src/main/java/com/vincent/rsf/server/manager/entity/Warehouse.java b/rsf-server/src/main/java/com/vincent/rsf/server/manager/entity/Warehouse.java index 37a8c84..a2b9775 100644 --- a/rsf-server/src/main/java/com/vincent/rsf/server/manager/entity/Warehouse.java +++ b/rsf-server/src/main/java/com/vincent/rsf/server/manager/entity/Warehouse.java @@ -23,6 +23,7 @@ @Data @TableName("man_warehouse") +@ApiModel(value = "Warehouse", description = "浠撳簱鍩虹淇℃伅") public class Warehouse implements Serializable { private static final long serialVersionUID = 1L; -- Gitblit v1.9.1