feat: 添加可选的 pid 参数类、修改权限树查询 pid 为可选参数、新增 meta 输出文档示例

basic-auth/src/main/java/com/yiring/auth/vo/permission/PermissionVo.java

@@ -64,7 +64,7 @@ public class PermissionVo implements Serializable {
     @ApiModelProperty(value = "父级ID", example = "0")
     String pid;
 
-    @ApiModelProperty(value = "元数据", example = "{}")
+    @ApiModelProperty(value = "元数据", example = "{\"title\": \"routes.dashboard.dashboard\"}")
     JSONObject meta;
 
     @ApiModelProperty(value = "子权限")

basic-auth/src/main/java/com/yiring/auth/web/permission/PermissionController.java

@@ -11,8 +11,8 @@ import com.yiring.auth.vo.permission.PermissionVo;
 import com.yiring.common.core.Result;
 import com.yiring.common.core.Status;
 import com.yiring.common.param.IdParam;
+import com.yiring.common.param.OptionalPidParam;
 import com.yiring.common.param.PageParam;
-import com.yiring.common.param.PidParam;
 import com.yiring.common.vo.PageVo;
 import io.swagger.annotations.Api;
 import io.swagger.annotations.ApiOperation;
@@ -25,7 +25,6 @@ import lombok.extern.slf4j.Slf4j;
 import org.springframework.beans.BeanUtils;
 import org.springframework.data.domain.Example;
 import org.springframework.data.domain.Page;
-import org.springframework.http.MediaType;
 import org.springframework.validation.annotation.Validated;
 import org.springframework.web.bind.annotation.GetMapping;
 import org.springframework.web.bind.annotation.PostMapping;
@@ -124,12 +123,12 @@ public class PermissionController {
     }
 
     @ApiOperation(value = "树结构查询")
-    @GetMapping(value = "tree", headers = "Content-Type=" + MediaType.APPLICATION_FORM_URLENCODED_VALUE)
-    public Result<ArrayList<PermissionVo>> tree(@Valid PidParam param) {
+    @GetMapping(value = "tree")
+    public Result<ArrayList<PermissionVo>> tree(@Valid OptionalPidParam param) {
         List<Permission> permissions = permissionRepository.findAll();
         List<PermissionVo> vos = Permissions.toTree(
             permissions,
-            StrUtil.isEmpty(param.getPid()) ? "0" : param.getPid()
+            StrUtil.isBlank(param.getPid()) ? "0" : param.getPid()
         );
         return Result.ok((ArrayList<PermissionVo>) vos);
     }

basic-common/core/src/main/java/com/yiring/common/param/OptionalPidParam.java

+/* (C) 2021 YiRing, Inc. */
+package com.yiring.common.param;
+
+import io.swagger.annotations.ApiModel;
+import io.swagger.annotations.ApiModelProperty;
+import java.io.Serial;
+import java.io.Serializable;
+import javax.validation.Valid;
+import lombok.*;
+import lombok.experimental.FieldDefaults;
+
+/**
+ * 公共的可选父级 ID 查询参数
+ *
+ * @author ifzm
+ * @version 0.1
+ * 2019/5/28 22:11
+ */
+@ApiModel(value = "OptionalPidParam", description = "公共的可选父级 ID 查询参数")
+@Valid
+@Data
+@Builder
+@NoArgsConstructor
+@AllArgsConstructor
+@FieldDefaults(level = AccessLevel.PRIVATE)
+public class OptionalPidParam implements Serializable {
+
+    @Serial
+    private static final long serialVersionUID = -8690942241103456893L;
+
+    @ApiModelProperty(value = "pid", example = "0")
+    String pid;
+}