add annotations

syswu · syswu · commit c6dffc5a7dec · 2023-07-25T14:16:55.000+08:00
diff --git a/src/main/java/io/github/kubesys/client/KubernetesClient.java b/src/main/java/io/github/kubesys/client/KubernetesClient.java
@@ -229,7 +229,7 @@ public KubernetesClient(String url, String username, String password, Kubernetes
 	 * @return String
 	 * @throws Exception Exception
 	 */
-	@Api(desc = "通过YAML文件创建Kubernetes资源")
+	@Api(description = "通过YAML文件创建Kubernetes资源", date = "2023/07/25", exceptions = {})
 	public String createResourceUsingYaml(String yaml) throws Exception {
 		ObjectMapper mapper = new ObjectMapper(new YAMLFactory());
 		JsonNode jsonNode = mapper.readTree(yaml);
diff --git a/src/main/java/io/github/kubesys/client/annotations/Api.java b/src/main/java/io/github/kubesys/client/annotations/Api.java
@@ -16,17 +16,16 @@
  * @version 1.0.0
  *
  */
-@Target({ElementType.METHOD, ElementType.TYPE}) 
+@Target({ElementType.METHOD, ElementType.CONSTRUCTOR}) 
 @Retention(RetentionPolicy.RUNTIME)
 @Documented
 public @interface Api {
 
-	String desc() default "";
+	String description() default "";
 	
-	String author() default "";
+	String[] author() default {};
 	
 	String date() default "";
 
-	String exceptions() default "";
-	
+	Class<?>[] exceptions() default {};
 }
diff --git a/src/main/java/io/github/kubesys/client/annotations/Catch.java b/src/main/java/io/github/kubesys/client/annotations/Catch.java
@@ -23,5 +23,5 @@
 
 	int code() default -1;
 	
-	String exception() default "";
+	String description() default "";
 }
diff --git a/src/main/java/io/github/kubesys/client/annotations/Env.java b/src/main/java/io/github/kubesys/client/annotations/Env.java
@@ -21,8 +21,9 @@
 @Documented
 public @interface Env {
 
-	String desc() default "";
+	String description() default "";
 	
 	String example() default "";
 	
+	String defaultValue() default "";
 }
diff --git a/src/main/java/io/github/kubesys/client/annotations/Param.java b/src/main/java/io/github/kubesys/client/annotations/Param.java
@@ -21,7 +21,7 @@
 @Documented
 public @interface Param {
 
-	String desc() default "";
+	String description() default "";
 	
 	String regexp() default "";
 	
diff --git a/src/main/java/io/github/kubesys/client/exceptions/KubernetesBadRequestException.java b/src/main/java/io/github/kubesys/client/exceptions/KubernetesBadRequestException.java
@@ -11,7 +11,7 @@
  * @version 1.0.0
  *
  */
-@Catch(code = 400, exception = "请求无效，服务器无法理解请求")
+@Catch(code = 400, description = "请求无效，服务器无法理解请求")
 public class KubernetesBadRequestException extends RuntimeException {
 
 	/**
diff --git a/src/main/java/io/github/kubesys/client/exceptions/KubernetesConflictResourceException.java b/src/main/java/io/github/kubesys/client/exceptions/KubernetesConflictResourceException.java
@@ -11,7 +11,7 @@
  * @version 1.0.0
  *
  */
-@Catch(code = 409, exception = "请求冲突，通常用于表示资源的当前状态与请求的条件不匹配")
+@Catch(code = 409, description = "请求冲突，通常用于表示资源的当前状态与请求的条件不匹配")
 public class KubernetesConflictResourceException extends RuntimeException {
 
 	/**
diff --git a/src/main/java/io/github/kubesys/client/exceptions/KubernetesForbiddenAccessException.java b/src/main/java/io/github/kubesys/client/exceptions/KubernetesForbiddenAccessException.java
@@ -11,7 +11,7 @@
  * @version 1.0.0
  *
  */
-@Catch(code = 403, exception = "请求被拒绝，客户端没有访问资源的权限")
+@Catch(code = 403, description = "请求被拒绝，客户端没有访问资源的权限")
 public class KubernetesForbiddenAccessException extends RuntimeException {
 
 	/**
diff --git a/src/main/java/io/github/kubesys/client/exceptions/KubernetesInternalServerErrorException.java b/src/main/java/io/github/kubesys/client/exceptions/KubernetesInternalServerErrorException.java
@@ -11,7 +11,7 @@
  * @version 1.0.0
  *
  */
-@Catch(code = 500, exception = "服务器内部错误，表示服务器在处理请求时遇到了问题")
+@Catch(code = 500, description = "服务器内部错误，表示服务器在处理请求时遇到了问题")
 public class KubernetesInternalServerErrorException extends RuntimeException {
 
 	/**
diff --git a/src/main/java/io/github/kubesys/client/exceptions/KubernetesResourceNotFoundException.java b/src/main/java/io/github/kubesys/client/exceptions/KubernetesResourceNotFoundException.java
@@ -11,7 +11,7 @@
  * @version 1.0.0
  *
  */
-@Catch(code = 404, exception = "请求的资源不存在")
+@Catch(code = 404, description = "请求的资源不存在")
 public class KubernetesResourceNotFoundException extends RuntimeException {
 
 	/**
diff --git a/src/main/java/io/github/kubesys/client/exceptions/KubernetesUnauthorizedTokenException.java b/src/main/java/io/github/kubesys/client/exceptions/KubernetesUnauthorizedTokenException.java
@@ -11,7 +11,7 @@
  * @version 1.0.0
  *
  */
-@Catch(code = 401, exception = "未授权，需要进行身份验证或令牌无效")
+@Catch(code = 401, description = "未授权，需要进行身份验证或令牌无效")
 public class KubernetesUnauthorizedTokenException extends RuntimeException {
 
 	/**
diff --git a/src/main/java/io/github/kubesys/client/exceptions/KubernetesUnknownException.java b/src/main/java/io/github/kubesys/client/exceptions/KubernetesUnknownException.java
@@ -11,7 +11,7 @@
  * @version 1.0.0
  *
  */
-@Catch(code = 402, exception = "错误的Kubernetes地址")
+@Catch(code = 402, description = "错误的Kubernetes地址")
 public class KubernetesUnknownException extends RuntimeException {
 
 	/**
diff --git a/src/main/java/io/github/kubesys/client/exceptions/KubernetesUnknownUrlException.java b/src/main/java/io/github/kubesys/client/exceptions/KubernetesUnknownUrlException.java
@@ -11,7 +11,7 @@
  * @version 1.0.0
  *
  */
-@Catch(code = 402, exception = "Kubernetes的请求地址缺少协议 http，或者是https")
+@Catch(code = 402, description = "Kubernetes的请求地址缺少协议 http，或者是https")
 public class KubernetesUnknownUrlException extends RuntimeException {
 
 	/**

Original file line number	Diff line number	Diff line change
`@@ -23,5 +23,5 @@`
`23`	`23`
`24`	`24`	`int code() default -1;`
`25`	`25`
`26`		`- String exception() default "";`
	`26`	`+ String description() default "";`
`27`	`27`	`}`
Original file line number	Diff line number	Diff line change
`@@ -21,8 +21,9 @@`
`21`	`21`	`@Documented`
`22`	`22`	`public @interface Env {`
`23`	`23`
`24`		`- String desc() default "";`
	`24`	`+ String description() default "";`
`25`	`25`
`26`	`26`	`String example() default "";`
`27`	`27`
	`28`	`+ String defaultValue() default "";`
`28`	`29`	`}`
Original file line number	Diff line number	Diff line change
`@@ -11,7 +11,7 @@`
`11`	`11`	`* @version 1.0.0`
`12`	`12`	`*`
`13`	`13`	`*/`
`14`		`-@Catch(code = 400, exception = "请求无效，服务器无法理解请求")`
	`14`	`+@Catch(code = 400, description = "请求无效，服务器无法理解请求")`
`15`	`15`	`public class KubernetesBadRequestException extends RuntimeException {`
`16`	`16`
`17`	`17`	`/**`