fooReturnGenericTypeMap() {
+ return null;
+ }
+}
diff --git a/src/main/java/com/power/doc/usecase/rest/api/response/ResponseExampleUseCase.java b/src/main/java/com/power/doc/usecase/rest/api/response/ResponseExampleUseCase.java
new file mode 100644
index 0000000..7a7d8d4
--- /dev/null
+++ b/src/main/java/com/power/doc/usecase/rest/api/response/ResponseExampleUseCase.java
@@ -0,0 +1,61 @@
+package com.power.doc.usecase.rest.api.response;
+
+import com.power.doc.usecase.rest.pojo.required.BarJsr303;
+import com.power.doc.usecase.rest.pojo.value.BarValue;
+import com.power.doc.usecase.rest.pojo.value.FooValue;
+
+import org.springframework.web.bind.annotation.GetMapping;
+import org.springframework.web.bind.annotation.RequestMapping;
+import org.springframework.web.bind.annotation.RestController;
+
+/**
+ * Response Example
+ * @author zongzi
+ */
+@RestController
+@RequestMapping("/response/response-example")
+public class ResponseExampleUseCase {
+ /**
+ * Return With Default Auto Mock
+ * @apiNote 在默认情况下smart-doc可以根据参数的类型为你生成示例值
+ * 注意：
+ * 1、TODO #021 下方Response-example一栏中的"fooByte"示例值为字符串，存在问题
+ * 2、TODO #022 下方Response-example一栏中的"fooCharInBox"示例值为字符串，存在问题
+ * 3、TODO #023 下方Response-example一栏中的"fooEnumMap"示例值的Key为MapKey，是否存在问题？
+ * @param foo 测试对象
+ */
+ @GetMapping("/return-with-default_mock")
+ public FooValue defaultMock() {
+ return null;
+ }
+
+ /**
+ * Return Type With @mock Tag
+ * @apiNote 也可以使用@mock来自己指定示例值（通过在属性上使用@mock)字段,如下所示
+ *
+ * class BarValue{
+ * //@mock "this is my mock string with "{"fooString":"123"} \" "
+ * String barString;
+ * //@mock 123a
+ * int barInt;
+ * //这里没有使用@mock注解，则交由smart-doc自动生成示例值
+ * long barLong;
+ * }
+ *
+ */
+ @GetMapping("/return-self-type-with-manual-mock")
+ public BarValue manualMock() {
+ return null;
+ }
+
+
+ /**
+ * Return Type Use JSR-303
+ * @apiNote 使用JSR-303的注解无法影响示例值的产生逻辑。
+ * @return BarJsr303
+ */
+ @GetMapping("/example-with-jsr-303")
+ public BarJsr303 exampleWithJsr303() {
+ return null;
+ }
+}
diff --git a/src/main/java/com/power/doc/usecase/rest/api/response/ResponseFieldNameUseCase.java b/src/main/java/com/power/doc/usecase/rest/api/response/ResponseFieldNameUseCase.java
new file mode 100644
index 0000000..39f20be
--- /dev/null
+++ b/src/main/java/com/power/doc/usecase/rest/api/response/ResponseFieldNameUseCase.java
@@ -0,0 +1,75 @@
+package com.power.doc.usecase.rest.api.response;
+
+import com.power.doc.usecase.rest.pojo.parameter.FooJsonParameterName;
+import com.power.doc.usecase.rest.pojo.parameter.FooParameterName;
+
+import org.springframework.web.bind.annotation.PostMapping;
+import org.springframework.web.bind.annotation.RequestMapping;
+import org.springframework.web.bind.annotation.RestController;
+
+/**
+ * Response Filed Name
+ * @author zongzi
+ */
+@RestController
+@RequestMapping("/response/field-name")
+public class ResponseFieldNameUseCase {
+ /**
+ * Ignore Some Parameter(Use @ignore)
+ * @apiNote 使用@ignore字段可以在生成的Body-Parameter字段中忽略一些字段，
+ * 举例说明：声明一个对象Foo
+ *
+ * class Foo{
+ * // 此字段应该被正常渲染
+ * String fooStringNotIgnore;
+ *
+ * //此字段会在最后的渲染结果中被忽略
+ * //@ignore
+ * String fooStringToIgnore;
+ *
+ * }
+ *
+ * 并在方法上返回
+ * TODO #032 在Response-example中，产生了被忽略值的示例，和Response-fields中的表现不一致
+ * @return FooParameterName 示例对象
+ */
+ @PostMapping("/use-ignore")
+ public FooParameterName fooUseIgnore() {
+ return null;
+ }
+
+ /**
+ * Use Jackson Annotations
+ * @apiNote 使用 com.fasterxml.jackson.annotation 下的注解
+ * `@JsonProperty / `@JsonProperty / `@JsonIgnore /`@JsonIgnoreType进行用例展示
+ *
+ * `@JsonIgnoreProperties({"fooClassStringToIgnore"})
+ * class Foo{
+ * //此字段
+ * `@JsonProperty("fooString")
+ * String fooStringWithJsonAnnotation;
+ *
+ * `@JsonIgnore
+ * String fooStringToIgnore;
+ *
+ * //在Class上声明被忽略的成员变量
+ * String fooClassStringToIgnore;
+ *
+ * //使用@JsonIgnoreType声明的类型
+ * Bar bar;
+ * }
+ * `@JsonIgnoreType
+ * `@Data
+ * class Bar {
+ * String barString;
+ * }
+ *
+ * TODO #033 JsonIgnoreType似乎没有起作用，查看下方的Response-fields, bar字段还是正常显示了
+ * @return FooJsonParameterName 使用了一些jackson的注解对象
+ *
+ */
+ @PostMapping("/use-jackson-annotation")
+ public FooJsonParameterName fooUseFastJsonAnnotation() {
+ return null;
+ }
+}
diff --git a/src/main/java/com/power/doc/usecase/rest/api/response/ResponseSinceFieldUseCase.java b/src/main/java/com/power/doc/usecase/rest/api/response/ResponseSinceFieldUseCase.java
new file mode 100644
index 0000000..84ec7a9
--- /dev/null
+++ b/src/main/java/com/power/doc/usecase/rest/api/response/ResponseSinceFieldUseCase.java
@@ -0,0 +1,50 @@
+package com.power.doc.usecase.rest.api.response;
+
+import org.springframework.web.bind.annotation.GetMapping;
+import org.springframework.web.bind.annotation.RequestMapping;
+import org.springframework.web.bind.annotation.RestController;
+
+/**
+ * Since Field
+ * @author zongzi
+ */
+@RestController
+@RequestMapping("/response/since/")
+public class ResponseSinceFieldUseCase {
+
+
+ /**
+ * Usage of @since tag
+ */
+ @GetMapping("usage-of-since-tag")
+ public FooSince foo() {
+ return null;
+ }
+
+}
+class FooSince{
+ /**
+ * Use case of single @since tag
+ * @since 0.0.0.1
+ */
+ String fooString;
+ /**
+ * Use case of multiple @since tag
+ * @since 0.0.0.1
+ * @since 0.0.0.2
+ */
+ Integer fooInteger;
+
+ /**
+ * Use case of @since with special characters (etc. html,multiple lines)
+ * @since 2022-12-01_11.1.1.1
+ * @since 2022-12-01の11.1.1.1
+ * @since 2.5.3
+ * @since this is a since tag use
+ * multiple lines
+ * @since @mock @param @ignore @return
+ * @since 123456@qq.com
+ * @since ,,,,,,,,,,
+ */
+ Long fooLong;
+}
\ No newline at end of file
diff --git a/src/main/java/com/power/doc/usecase/rest/api/response/ResponseTypeFieldUseCase.java b/src/main/java/com/power/doc/usecase/rest/api/response/ResponseTypeFieldUseCase.java
new file mode 100644
index 0000000..ed6c4a8
--- /dev/null
+++ b/src/main/java/com/power/doc/usecase/rest/api/response/ResponseTypeFieldUseCase.java
@@ -0,0 +1,193 @@
+package com.power.doc.usecase.rest.api.response;
+
+import java.util.List;
+import java.util.Map;
+
+import com.power.doc.usecase.rest.pojo.result.BarResult;
+import com.power.doc.usecase.rest.pojo.result.FooResult;
+import com.power.doc.usecase.rest.pojo.type.BarType;
+import com.power.doc.usecase.rest.pojo.type.FooCircleDependency;
+import com.power.doc.usecase.rest.pojo.type.FooType;
+
+import org.springframework.web.bind.annotation.GetMapping;
+import org.springframework.web.bind.annotation.RequestMapping;
+import org.springframework.web.bind.annotation.RestController;
+
+/**
+ * Type Field
+ * @author zongzi
+ */
+@RestController
+@RequestMapping("/response/type-field")
+public class ResponseTypeFieldUseCase {
+ /**
+ * Return Basic Type
+ * @apiNote 返回基本类型
+ *
+ * `@GetMapping("/return-basic-type")
+ * public Integer fooReturnBasicType(){};
+ *
+ * TODO #034 返回基础类型时，没有Response-fields字段了,和Response-example的表现不一致
+ * @return Integer id
+ */
+ @GetMapping("/return-basic-type")
+ public Integer fooReturnBasicType() {
+ return null;
+ }
+
+ /**
+ * Return Self-Definition Type
+ * @apiNote 自定义类型, 可以直接在参数列表中声明，代码如下
+ *
+ * `@GetMapping("/return-sel-definition-type")`
+ * public void fooReturnSelfDefinitionType(){}
+ *
+ *
+ * @return FooType 测试自定义对象
+ */
+ @GetMapping("/return-sel-definition-type")
+ public FooType fooReturnSelfDefinitionType() {
+ return null;
+ }
+
+ /**
+ * Return Dependency Type
+ * @apiNote 返回 Foo对象，foo的成员变量有bar，bar的成员变量有foo
+ *
+ * @return FooCircleDependency 测试对象
+ */
+ @GetMapping("/return-circle-dependency-type")
+ public FooCircleDependency fooReturnCircleDependency() {
+ return null;
+ }
+
+
+ /**
+ * Return Integers[]
+ * @apiNote 声明基础类型数组作为返回对象
+ * TODO ?002 返回的对象是Array, 但是Type显示为int32, 是否需要改为Array？或者在Description进行说明, 下面的三个用例的情况基本相同
+ * @return Integer[] 测试ID列表
+ */
+ @GetMapping("/return-basic-type-array")
+ public Integer[] fooReturnArrayBasicType() {
+ return null;
+ }
+
+ /**
+ * Return Boo[]
+ * @apiNote 声明对象数组作为返回对象
+ * @return BarType[] 测试对象数组
+ */
+ @GetMapping("return-object-array")
+ public BarType[] fooReturnArrayObjects() {
+ return null;
+ }
+
+
+ /**
+ * Return List
+ * @apiNote 使用泛型声明作为返回对象
+ * @param List 测试对象列表
+ */
+ @GetMapping("return-type-list")
+ public List fooReturnTypeList() {
+ return null;
+ }
+
+ /**
+ * Return List
+ * @apiNote 使用泛型声明作为返回对象
+ * @param List 测试对象列表
+ */
+ @GetMapping("return-type-list")
+ public List fooReturnCircleDependencyTypeList() {
+ return null;
+ }
+
+ /**
+ * Return List>
+ * @apiNote 使用泛型声明作为返回对象
+ * @param List 测试对象列表
+ */
+ @GetMapping("return-map-type-list")
+ public List> fooReturnMapStringTypeList() {
+ return null;
+ }
+
+ /**
+ * Return Map
+ * @apiNote 使用Map作为返回对象
+ * TODO ?004 对比下方的Map的返回类型，似乎Type字段应该支持 map 等类似的描述？
+ * @return Map 测试对象列表
+ */
+ @GetMapping("return-map-string-string")
+ public Map fooReturnStringTypeMap() {
+ return null;
+ }
+
+ /**
+ * Return Map
+ * @apiNote 使用Map作为返回对象
+ * @return Map 返回对象类型
+ */
+ @GetMapping("return-map-string-self-type")
+ public Map fooReturnGenericTypeMap() {
+ return null;
+ }
+
+ /**
+ * Return Map>
+ * @apiNote 使用Map>作为返回对象
+ * @return Map> 返回对象类型
+ */
+ @GetMapping("return-map-string-list-self-type")
+ public Map> fooReturnMapListSelfType() {
+ return null;
+ }
+
+ /**
+ * Return Result
+ * @return FooResult
+ */
+ @GetMapping
+ public FooResult fooReturnGenericResult() {
+ return null;
+ }
+
+ /**
+ * Return Result
+ * @return FooResult
+ */
+ @GetMapping
+ public FooResult fooReturnGenericBasicTypeResult() {
+ return null;
+ }
+
+ /**
+ * Return Result>
+ * @return FooResult
+ */
+ @GetMapping
+ public FooResult> fooReturnGenericListBasicTypeResult() {
+ return null;
+ }
+
+ /**
+ * Return Result>
+ * @return FooResult
+ */
+ @GetMapping
+ public FooResult> fooReturnGenericListSelfTypeResult() {
+ return null;
+ }
+
+ /**
+ * Return Result
+ * @return
+ */
+ @GetMapping
+ public BarResult fooReturnGenericType2() {
+ return null;
+ }
+}
+
diff --git a/src/main/java/com/power/doc/usecase/rest/pojo/description/BarDescription.java b/src/main/java/com/power/doc/usecase/rest/pojo/description/BarDescription.java
new file mode 100644
index 0000000..57ace4c
--- /dev/null
+++ b/src/main/java/com/power/doc/usecase/rest/pojo/description/BarDescription.java
@@ -0,0 +1,44 @@
+package com.power.doc.usecase.rest.pojo.description;
+
+import lombok.Data;
+
+/**
+ * 特殊字符测试
+ * @author zongzi
+ */
+@Data
+public class BarDescription {
+ /**
+ * `!@#$%^&*()_~{}[]\;':",./<>?
+ * (*´▽｀)ノノ
+ * (灬ꈍ ꈍ灬)
+ * 🤺
+ * 😂
+ * の
+ */
+ String barString;
+
+ /**
+ * < >
+ * ccccccc
+ *
+ * 这是一个段落
+ * System.out.println("this are some code")
+ *
+ * {@code System.out.println("this is a code snippet use @code ")
+ *
+ *
+ * public class Foo {
+ * private String fooString;
+ * }
+ *
+ *
+ * aaa
+ * bbb
+ *
+ * ``
+ * this is a link to smart-doc's doc
+ * TODO #014 如果代码中的注释使用`Map<_;String,Bar>_;`则生成的HTML文档中所有其他地方的< 会变成<(即进行转义),如果是类成员变量上的HTML代码，也可以在结果中正常渲染
+ */
+ int barInt;
+}
diff --git a/src/main/java/com/power/doc/usecase/rest/pojo/description/FooDescription.java b/src/main/java/com/power/doc/usecase/rest/pojo/description/FooDescription.java
new file mode 100644
index 0000000..a95210b
--- /dev/null
+++ b/src/main/java/com/power/doc/usecase/rest/pojo/description/FooDescription.java
@@ -0,0 +1,15 @@
+package com.power.doc.usecase.rest.pojo.description;
+
+import lombok.Data;
+
+/**
+ * 用例表述对象
+ * @author zongzi
+ */
+@Data
+public class FooDescription {
+ /**
+ * 测试参数说明
+ */
+ String fooString;
+}
diff --git a/src/main/java/com/power/doc/usecase/rest/pojo/parameter/BarJsonParameterName.java b/src/main/java/com/power/doc/usecase/rest/pojo/parameter/BarJsonParameterName.java
new file mode 100644
index 0000000..6f6b4bf
--- /dev/null
+++ b/src/main/java/com/power/doc/usecase/rest/pojo/parameter/BarJsonParameterName.java
@@ -0,0 +1,14 @@
+package com.power.doc.usecase.rest.pojo.parameter;
+
+import com.fasterxml.jackson.annotation.JsonIgnoreType;
+import lombok.Data;
+
+/**
+ * 被忽略的com.fasterxml.jackson.annotation注解
+ * @author zongzi
+ */
+@JsonIgnoreType
+@Data
+public class BarJsonParameterName {
+ String barString;
+}
diff --git a/src/main/java/com/power/doc/usecase/rest/pojo/parameter/FooJsonParameterName.java b/src/main/java/com/power/doc/usecase/rest/pojo/parameter/FooJsonParameterName.java
new file mode 100644
index 0000000..1e7d4b6
--- /dev/null
+++ b/src/main/java/com/power/doc/usecase/rest/pojo/parameter/FooJsonParameterName.java
@@ -0,0 +1,34 @@
+package com.power.doc.usecase.rest.pojo.parameter;
+
+import com.fasterxml.jackson.annotation.JsonIgnore;
+import com.fasterxml.jackson.annotation.JsonIgnoreProperties;
+import com.fasterxml.jackson.annotation.JsonProperty;
+import lombok.Data;
+
+/**
+ * 使用com.fasterxml.jackson.annotation注解的返回结果
+ * @author zongzi
+ */
+@Data
+@JsonIgnoreProperties({"fooClassStringToIgnore"})
+public class FooJsonParameterName {
+ /**
+ * 此处对象中声明的参数名是：fooStringWithJsonAnnotation,
+ * 但是使用了 @JsonProperty("fooString") 将参数名更新为fooString
+ */
+ @JsonProperty("fooString")
+ String fooStringWithJsonAnnotation;
+
+ @JsonIgnore
+ String fooStringToIgnore;
+
+ /**
+ * 在Class上声明被忽略的成员变量
+ */
+ String fooClassStringToIgnore;
+
+ /**
+ * 使用@JsonIgnoreType声明的类型,应该被忽略
+ */
+ BarJsonParameterName bar;
+}
diff --git a/src/main/java/com/power/doc/usecase/rest/pojo/parameter/FooParameterName.java b/src/main/java/com/power/doc/usecase/rest/pojo/parameter/FooParameterName.java
new file mode 100644
index 0000000..46d98b0
--- /dev/null
+++ b/src/main/java/com/power/doc/usecase/rest/pojo/parameter/FooParameterName.java
@@ -0,0 +1,18 @@
+package com.power.doc.usecase.rest.pojo.parameter;
+
+import lombok.Data;
+
+@Data
+public class FooParameterName {
+
+ /**
+ * 此字段应该被正常渲染
+ */
+ String fooStringNotIgnore;
+ /**
+ * 此字段会在最后的渲染结果中被忽略
+ * @ignore
+ */
+ String fooStringToIgnore;
+
+}
diff --git a/src/main/java/com/power/doc/usecase/rest/pojo/required/BarJsr303.java b/src/main/java/com/power/doc/usecase/rest/pojo/required/BarJsr303.java
new file mode 100644
index 0000000..427db28
--- /dev/null
+++ b/src/main/java/com/power/doc/usecase/rest/pojo/required/BarJsr303.java
@@ -0,0 +1,145 @@
+package com.power.doc.usecase.rest.pojo.required;
+
+import java.util.Date;
+import java.util.List;
+
+import javax.validation.constraints.AssertFalse;
+import javax.validation.constraints.AssertTrue;
+import javax.validation.constraints.DecimalMax;
+import javax.validation.constraints.DecimalMin;
+import javax.validation.constraints.Digits;
+import javax.validation.constraints.Email;
+import javax.validation.constraints.Future;
+import javax.validation.constraints.FutureOrPresent;
+import javax.validation.constraints.Max;
+import javax.validation.constraints.Min;
+import javax.validation.constraints.Negative;
+import javax.validation.constraints.NegativeOrZero;
+import javax.validation.constraints.NotBlank;
+import javax.validation.constraints.NotEmpty;
+import javax.validation.constraints.NotNull;
+import javax.validation.constraints.Null;
+import javax.validation.constraints.Past;
+import javax.validation.constraints.PastOrPresent;
+import javax.validation.constraints.Pattern;
+import javax.validation.constraints.Positive;
+import javax.validation.constraints.PositiveOrZero;
+import javax.validation.constraints.Size;
+
+import lombok.Data;
+
+/**
+ * 测试JSR-303标准注解
+ * @author zongzi
+ */
+@Data
+public class BarJsr303 {
+ /**
+ * 使用@NotNull规定必须不为空
+ */
+ @NotNull
+ String barNotNullString;
+
+ @NotBlank
+ String barNotBlankString;
+
+ @NotEmpty
+ String barNotEmptyString;
+
+ /**
+ * #019-1 示例值应为空，此处正常生成了示例值
+ */
+ @Null
+ String barMustNullString;
+
+ @AssertTrue
+ Boolean barMustTureBool;
+
+ /**
+ * #019-2 示例值应为False，此处生成的示例值为True
+ */
+ @AssertFalse
+ Boolean barMustFalseBool;
+
+ @PositiveOrZero
+ Integer barPositiveOrZeroInt;
+
+ @Positive
+ Integer barPositiveInt;
+
+ /**
+ * #019-3 示例值为正数
+ */
+ @NegativeOrZero
+ Integer barNegativeOrZeroInt;
+
+ /**
+ * #019-4 示例值为正数
+ */
+ @Negative
+ Integer barNegativeInt;
+
+
+ @Min(10)
+ int barMinInt;
+
+ /**
+ * #019-5 最大值为11，示例值大于11
+ */
+ @Max(11)
+ int barMaxInt;
+
+ @DecimalMin("10")
+ Long barMinDecimal;
+
+ /**
+ * #019-6 最大值为100
+ */
+ @DecimalMax("100")
+ Long barMaxDecimal;
+
+
+ /**
+ * #019-7-0 Size[3,4]
+ * #019-7-1 对于@Size注解，自动生成的Validate[],只声明了Max，没有声明Min
+ */
+ @Size(min = 3, max = 4)
+ String barSizeString;
+
+ /**
+ * #019-8 Size[3,4]
+ */
+ @Size(min = 3, max = 4)
+ List barSizeStringArray;
+
+ /**
+ * #019-8 Digits(100.100)
+ */
+ @Digits(integer = 100, fraction = 99)
+ Double barDigitsDouble;
+
+ @Past
+ Date barPastDate;
+ @PastOrPresent
+ Date barPastOrPresent;
+
+ @Future
+ Date barFutureDate;
+ @FutureOrPresent
+ Date barFutureOrPresentDate;
+
+ /**
+ * #019-10 如果声明了注释，就会省略null，结合下面的字段一起查看
+ */
+ @Pattern(regexp = ".*")
+ String barPatternStringWithComment;
+
+ @Pattern(regexp = ".*")
+ String barPatternString;
+
+ /**
+ * #019-11 可以使用类似Xeger的库生成符合对应正则的实例字符串
+ */
+ @Email(regexp = ".*")
+ String barEmailString;
+}
diff --git a/src/main/java/com/power/doc/usecase/rest/pojo/required/FooRequired.java b/src/main/java/com/power/doc/usecase/rest/pojo/required/FooRequired.java
new file mode 100644
index 0000000..7f25b25
--- /dev/null
+++ b/src/main/java/com/power/doc/usecase/rest/pojo/required/FooRequired.java
@@ -0,0 +1,19 @@
+package com.power.doc.usecase.rest.pojo.required;
+
+import lombok.Data;
+
+/**
+ * 测试必填字段
+ * @author zongzi
+ */
+@Data
+public class FooRequired {
+ /**
+ * 测试字符,必填
+ * @required
+ *
+ */
+ String fooString;
+
+ Integer fooInteger;
+}
diff --git a/src/main/java/com/power/doc/usecase/rest/pojo/result/BarResult.java b/src/main/java/com/power/doc/usecase/rest/pojo/result/BarResult.java
new file mode 100644
index 0000000..1f6a28d
--- /dev/null
+++ b/src/main/java/com/power/doc/usecase/rest/pojo/result/BarResult.java
@@ -0,0 +1,21 @@
+package com.power.doc.usecase.rest.pojo.result;
+
+import com.power.doc.usecase.rest.pojo.type.FooEnum;
+import lombok.Data;
+
+/**
+ * 多泛型的返回对象
+ * @author zongzi
+ * @param
+ * @param
+ */
+@Data
+public class BarResult{
+
+
+ FooEnum code;
+ String message;
+ K fooData;
+ V barData;
+ String traceId;
+}
diff --git a/src/main/java/com/power/doc/usecase/rest/pojo/result/FooResult.java b/src/main/java/com/power/doc/usecase/rest/pojo/result/FooResult.java
new file mode 100644
index 0000000..a85c16b
--- /dev/null
+++ b/src/main/java/com/power/doc/usecase/rest/pojo/result/FooResult.java
@@ -0,0 +1,29 @@
+package com.power.doc.usecase.rest.pojo.result;
+
+import lombok.Data;
+
+/**
+ * 泛型返回对象
+ * @author zongzi
+ * @param
+ */
+@Data
+public class FooResult {
+
+ /**
+ * 编码
+ */
+ String code;
+ /**
+ * ID
+ */
+ String traceId;
+ /**
+ * 数据
+ */
+ T data;
+ /**
+ * 描述
+ */
+ String message;
+}
diff --git a/src/main/java/com/power/doc/usecase/rest/pojo/type/BarEnum.java b/src/main/java/com/power/doc/usecase/rest/pojo/type/BarEnum.java
new file mode 100644
index 0000000..6575a8c
--- /dev/null
+++ b/src/main/java/com/power/doc/usecase/rest/pojo/type/BarEnum.java
@@ -0,0 +1,12 @@
+package com.power.doc.usecase.rest.pojo.type;
+
+/**
+ * 示例枚举对象
+ * @author zongzi
+ */
+public enum BarEnum {
+ /**
+ * 示例枚举对象
+ */
+ BAR_A,BAR_B,BAR_C
+}
diff --git a/src/main/java/com/power/doc/usecase/rest/pojo/type/BarType.java b/src/main/java/com/power/doc/usecase/rest/pojo/type/BarType.java
new file mode 100644
index 0000000..6238a74
--- /dev/null
+++ b/src/main/java/com/power/doc/usecase/rest/pojo/type/BarType.java
@@ -0,0 +1,12 @@
+package com.power.doc.usecase.rest.pojo.type;
+
+import lombok.Data;
+
+/**
+ * 测试简单对象
+ * @author zongzi
+ */
+@Data
+public class BarType {
+ String barString;
+}
diff --git a/src/main/java/com/power/doc/usecase/rest/pojo/type/FooCircleDependency.java b/src/main/java/com/power/doc/usecase/rest/pojo/type/FooCircleDependency.java
new file mode 100644
index 0000000..2ca0600
--- /dev/null
+++ b/src/main/java/com/power/doc/usecase/rest/pojo/type/FooCircleDependency.java
@@ -0,0 +1,35 @@
+package com.power.doc.usecase.rest.pojo.type;
+
+import javax.validation.constraints.NotNull;
+
+import lombok.Data;
+
+/**
+ * 循环依赖测试对象
+ * @author zongzi
+ */
+@Data
+public class FooCircleDependency {
+ /**
+ * foo自身成员变量
+ */
+ @NotNull
+ String fooString;
+
+ /**
+ * foo 的成员变量为bar
+ */
+ BarCircleDependency bar;
+}
+@Data
+class BarCircleDependency {
+ /**
+ * Bar的成员变量foo
+ */
+ FooCircleDependency foo;
+
+ /**
+ * bar自身成员变量
+ */
+ String barString;
+}
\ No newline at end of file
diff --git a/src/main/java/com/power/doc/usecase/rest/pojo/type/FooEnum.java b/src/main/java/com/power/doc/usecase/rest/pojo/type/FooEnum.java
new file mode 100644
index 0000000..ac826a2
--- /dev/null
+++ b/src/main/java/com/power/doc/usecase/rest/pojo/type/FooEnum.java
@@ -0,0 +1,36 @@
+package com.power.doc.usecase.rest.pojo.type;
+
+/**
+ * 测试枚举对象
+ * @author zongzi
+ */
+public enum FooEnum {
+ /**
+ * 示例枚举
+ */
+ FOO_A(1, "2"), FOO_B(1, "3"), FOO_C(2, "1");
+
+ private int fooInt;
+ private String fooString;
+
+ FooEnum(int i, String j) {
+ this.fooInt = i;
+ this.fooString = j;
+ }
+
+ public int getFooInt() {
+ return fooInt;
+ }
+
+ public void setFooInt(int fooInt) {
+ this.fooInt = fooInt;
+ }
+
+ public String getFooString() {
+ return fooString;
+ }
+
+ public void setFooString(String fooString) {
+ this.fooString = fooString;
+ }
+}
diff --git a/src/main/java/com/power/doc/usecase/rest/pojo/type/FooType.java b/src/main/java/com/power/doc/usecase/rest/pojo/type/FooType.java
new file mode 100644
index 0000000..f7add7a
--- /dev/null
+++ b/src/main/java/com/power/doc/usecase/rest/pojo/type/FooType.java
@@ -0,0 +1,75 @@
+package com.power.doc.usecase.rest.pojo.type;
+
+import java.math.BigDecimal;
+import java.util.Date;
+import java.util.List;
+import java.util.Map;
+
+import com.power.doc.usecase.rest.api.query.parameter.QueryParameterValueUseCase;
+import lombok.Data;
+
+/**
+ * 测试对象类型
+ * @author zongzi
+ */
+@Data
+public class FooType {
+ Boolean fooBooleanInBox;
+ boolean fooBoolean;
+ Character fooCharInBox;
+ char fooChar;
+ Double fooDoubleInBox;
+ double foolDouble;
+ Float fooFloatInBox;
+ float fooFloat;
+ /**
+ * TODO #005 如果这里使用的包装类型Byte类型, 显示的Type类型为Object,
+ */
+ Byte fooByteInBox;
+ byte fooByte;
+ Short fooShortInBox;
+ short foolShort;
+ Integer fooIntInBox;
+ int foolInt;
+ Long fooLongInBox;
+ long fooLong;
+ String fooString;
+ BigDecimal fooBigDecimal;
+ Date foolDate;
+ boolean[] fooBooleanArray;
+ char[] fooCharArray;
+ float[] fooFloatArray;
+ double[] fooDoubleArray;
+ byte[] fooByteArray;
+ short[] fooShortArray;
+ int[] fooIntArray;
+ BarType[] fooBarArray;
+ Long[] fooLongArray;
+ String[] fooStringArray;
+ List fooStringList;
+ BarType bar;
+ /**
+ * TODO #011 类型List<Bar>，示例值体现不出这是个Bar对象，
+ * 查看{@link QueryParameterValueUseCase}获取更多示例
+ */
+ List fooBarList;
+ /**
+ * TODO #012 类型List<String,Integer> 没有示例值，
+ * 查看{@link QueryParameterValueUseCase}获取更多示例
+ */
+ Map foolStringIntegerMap;
+
+ /**
+ * TODO #013 类型Map<String,Bar> 示例值体现不出这个Map中是String和Bar对象，
+ * 查看{@link QueryParameterValueUseCase}获取更多示例
+ */
+ Map foolStringBarMap;
+
+ FooEnum fooEnum;
+ List fooEnums;
+ /**
+ * TODO ?001 生成的Type字段中，是否需要指定Value的类型？
+ */
+ Map fooEnumMap;
+}
+
diff --git a/src/main/java/com/power/doc/usecase/rest/pojo/value/BarValue.java b/src/main/java/com/power/doc/usecase/rest/pojo/value/BarValue.java
new file mode 100644
index 0000000..afdcba2
--- /dev/null
+++ b/src/main/java/com/power/doc/usecase/rest/pojo/value/BarValue.java
@@ -0,0 +1,29 @@
+package com.power.doc.usecase.rest.pojo.value;
+
+import lombok.Data;
+
+
+/**
+ * 测试示例值对象
+ * @author zongzi
+ */
+@Data
+public class BarValue {
+
+ /**
+ * TODO #036 此处携带JSON的关键字符会影响生成的response-example和request-body
+ * @mock "this is my mock string with "{"fooString":"123"} \" "
+ */
+ String barString;
+
+ /**
+ * TODO #016 这个地方的mock示例值，如果类型不对，也能正常渲染结果
+ * @mock 123a
+ */
+ int barInt;
+
+ /**
+ * 这里没有使用@mock注解，则交由smart-doc自动生成示例值
+ */
+ long barLong;
+}
diff --git a/src/main/java/com/power/doc/usecase/rest/pojo/value/FooValue.java b/src/main/java/com/power/doc/usecase/rest/pojo/value/FooValue.java
new file mode 100644
index 0000000..66800b6
--- /dev/null
+++ b/src/main/java/com/power/doc/usecase/rest/pojo/value/FooValue.java
@@ -0,0 +1,89 @@
+package com.power.doc.usecase.rest.pojo.value;
+
+import java.math.BigDecimal;
+import java.util.Date;
+import java.util.List;
+import java.util.Map;
+
+import com.power.doc.usecase.rest.pojo.type.BarType;
+import lombok.Data;
+
+/**
+ * 测试示例值对象
+ * @author zongzi
+ */
+@Data
+public class FooValue {
+ Boolean fooBooleanInBox;
+ boolean fooBoolean;
+ /**
+ * TODO #015 如果是包装的Char类型，显示的示例值为多位的字符串
+ */
+ Character fooCharInBox;
+ char fooChar;
+ Double fooDoubleInBox;
+ double fooDouble;
+ Float fooFloatInBox;
+ float fooFloat;
+ Byte fooByteInBox;
+ byte fooByte;
+ Short fooShortInBox;
+ short fooShort;
+ Integer fooIntInBox;
+ int fooInt;
+ Long fooLongInBox;
+ long fooLong;
+ String fooString;
+ BigDecimal fooBigDecimal;
+ Date foolDate;
+ boolean[] fooBooleanArray;
+ char[] fooCharArray;
+ float[] fooFloatArray;
+ double[] fooDoubleArray;
+ byte[] fooByteArray;
+ short[] fooShortArray;
+ int[] fooIntArray;
+ BarType bar;
+ BarType[] fooBarArray;
+ Long[] fooLongArray;
+ String[] fooStringArray;
+ List fooStringList;
+ List fooBarList;
+ Map foolStringIntegerMap;
+ Map foolStringBarMap;
+ FooEnum fooEnum;
+ List fooEnums;
+ Map fooEnumMap;
+
+}
+
+enum FooEnum {
+ /**
+ * 示例枚举
+ */
+ BAR_A(1, "2"), BAR_B(1, "3"), BAR_C(2, "1");
+
+ private int fooInt;
+ private String fooString;
+
+ FooEnum(int i, String j) {
+ this.fooInt = i;
+ this.fooString = j;
+ }
+
+ public int getFooInt() {
+ return fooInt;
+ }
+
+ public void setFooInt(int fooInt) {
+ this.fooInt = fooInt;
+ }
+
+ public String getFooString() {
+ return fooString;
+ }
+
+ public void setFooString(String fooString) {
+ this.fooString = fooString;
+ }
+}
diff --git a/src/main/java/com/power/doc/usecase/rpc/api/meta/AuthorUseCase.java b/src/main/java/com/power/doc/usecase/rpc/api/meta/AuthorUseCase.java
new file mode 100644
index 0000000..a2ce2c9
--- /dev/null
+++ b/src/main/java/com/power/doc/usecase/rpc/api/meta/AuthorUseCase.java
@@ -0,0 +1,23 @@
+package com.power.doc.usecase.rpc.api.meta;
+
+/**
+ * RPC.Meta.Author Usecase
+ * @author zongzi
+ * @dubbo
+ */
+public interface AuthorUseCase {
+
+ /**
+ * Default Author
+ * @apiNote 默认的Service作者是空，可以通过@author指定
+ */
+ void defaultAuthorIsNull();
+
+
+ /**
+ * Method Author Is Not Available
+ * @apiNote 在方法上声明的@author是不会被渲染的
+ * @author zongzi-1
+ */
+ void methodVersionIsNotAvailable();
+}
diff --git a/src/main/java/com/power/doc/usecase/rpc/api/meta/ProtocolUseCase.java b/src/main/java/com/power/doc/usecase/rpc/api/meta/ProtocolUseCase.java
new file mode 100644
index 0000000..26c69f1
--- /dev/null
+++ b/src/main/java/com/power/doc/usecase/rpc/api/meta/ProtocolUseCase.java
@@ -0,0 +1,19 @@
+package com.power.doc.usecase.rpc.api.meta;
+
+/**
+ * RPC.Meta.Protocol Usecase
+ *
+ * @author zongzi
+ * @dubbo
+ */
+public interface ProtocolUseCase {
+
+ /**
+ * Default Protocol
+ * @apiNote TODO 0x01 一般情况下无法指定协议，都是dubbo。
+ * @since 2.5.3
+ */
+ void thereAreNoOtherWayToSpecifyProtocol();
+
+
+}
diff --git a/src/main/java/com/power/doc/usecase/rpc/api/meta/ServiceUseCase.java b/src/main/java/com/power/doc/usecase/rpc/api/meta/ServiceUseCase.java
new file mode 100644
index 0000000..d023ac9
--- /dev/null
+++ b/src/main/java/com/power/doc/usecase/rpc/api/meta/ServiceUseCase.java
@@ -0,0 +1,17 @@
+package com.power.doc.usecase.rpc.api.meta;
+
+/**
+ * RPC.Meta.Service Usecase
+ * @dubbo
+ * @author zongzi
+ */
+public interface ServiceUseCase {
+
+ /**
+ * Service Come From Class Path
+ * @apiNote RPC.Meta.Service 和 RPC.Meta.URI的生成逻辑相同
+ */
+ void fooServiceComeFromClassPath();
+}
+
+
diff --git a/src/main/java/com/power/doc/usecase/rpc/api/meta/UriUseCase.java b/src/main/java/com/power/doc/usecase/rpc/api/meta/UriUseCase.java
new file mode 100644
index 0000000..7f8784f
--- /dev/null
+++ b/src/main/java/com/power/doc/usecase/rpc/api/meta/UriUseCase.java
@@ -0,0 +1,29 @@
+package com.power.doc.usecase.rpc.api.meta;
+
+/**
+ * RPC.Meta.URI Usecase
+ * @dubbo
+ * @author zongzi
+ */
+interface UriUseCase {
+
+ /**
+ * URI Come From Interface's ClassPath
+ * @apiNote TODO 0x00 接口元数据中的URI来源于标注了@dubbo注解的类路径，但是会多带上http信息（因为smart-doc.json)中的配置。
+ */
+ void uriComeFromInterfaceClassPath();
+
+ /**
+ * RPC.Meta.URI(Inner Interface) Usecase
+ * @dubbo
+ */
+ interface FooInnerRpc{
+ /**
+ * URI Come From Interface's ClassPath
+ * @apiNote 即使是内部类，也会同样按照包路径+类名 生成接口级的文档
+ */
+ void foo();
+ }
+}
+
+
diff --git a/src/main/java/com/power/doc/usecase/rpc/api/meta/VersionUseCase.java b/src/main/java/com/power/doc/usecase/rpc/api/meta/VersionUseCase.java
new file mode 100644
index 0000000..9672855
--- /dev/null
+++ b/src/main/java/com/power/doc/usecase/rpc/api/meta/VersionUseCase.java
@@ -0,0 +1,36 @@
+package com.power.doc.usecase.rpc.api.meta;
+
+/**
+ * RPC.Meta.Version Usecase
+ * @author zongzi
+ * @dubbo
+ * @version 2.5.3
+ */
+public interface VersionUseCase {
+
+ /**
+ * Use @version
+ * @apiNote 可以使用@version来指定整个Dubbo Service的版本，不指定时，此项为空
+ */
+ void versionTagUse();
+
+ /**
+ * When Use Multiple Versions
+ * @apiNote 使用多个@version来指定dubbo，同时又包含继承关系，只会有最后一个version会生效，查看RPC.Meta.Version Inherit Use Case章节，
+ * 可以在@version字段使用html代码。
+ *
+ *
+ */
+ void multipleVersion();
+}
+
+
+/**
+ * RPC.Meta.Version Inherit Usecase
+ * @dubbo
+ * @author zongzi
+ * @version 1.2.2
+ */
+interface VersionInheritUseCase extends VersionUseCase {
+
+}
\ No newline at end of file
diff --git a/src/main/java/com/power/doc/usecase/rpc/api/method/invoke/DescriptionFieldUseCase.java b/src/main/java/com/power/doc/usecase/rpc/api/method/invoke/DescriptionFieldUseCase.java
new file mode 100644
index 0000000..1cfe32a
--- /dev/null
+++ b/src/main/java/com/power/doc/usecase/rpc/api/method/invoke/DescriptionFieldUseCase.java
@@ -0,0 +1,108 @@
+package com.power.doc.usecase.rpc.api.method.invoke;
+
+import java.math.BigDecimal;
+import java.util.Date;
+import java.util.List;
+import java.util.Set;
+
+import javax.validation.constraints.Email;
+import javax.validation.constraints.Max;
+import javax.validation.constraints.Pattern;
+import javax.validation.constraints.Size;
+
+import com.power.doc.usecase.rest.pojo.type.FooEnum;
+import com.power.doc.usecase.rpc.api.pojo.description.FooDescription;
+import org.beetl.ow2.asm.optimizer.Shrinker;
+
+/**
+ * RPC.Method.Invoke.Description Usecase
+ * @author zongzi
+ * @dubbo
+ */
+public interface DescriptionFieldUseCase {
+
+ /**
+ * Basic Type Description
+ * @apiNote 测试基本对象的Description的渲染效果
+ * @param fooByte 测试参数描述
+ * @param fooShort 测试参数描述
+ * @param fooInt 测试参数描述
+ * @param fooLong 测试参数描述
+ * @param fooBool 测试参数描述
+ * @param fooChar 测试参数描述
+ * @param fooDouble 测试参数描述
+ * @param fooFloat 测试参数描述
+ * @param fooDate 测试参数描述
+ * @param fooBigDecimal 测试参数描述
+ * @param fooString 测试参数描述
+ * @param fooEnum 测试参数描述 TODO 0x0A Description中没有展示枚举对象的示例值
+ */
+
+ void useBasicTypesBox(Byte fooByte, Short fooShort, Integer fooInt, Long fooLong, Boolean fooBool, Character fooChar, Double fooDouble, Float fooFloat,
+ Date fooDate, BigDecimal fooBigDecimal, String fooString, FooEnum fooEnum);
+
+
+ /**
+ * Use Arrays
+ * @apiNote 当使用数组时，Description中会展示(children type: xxx)
+ * TODO 0x0B 枚举数组被直接忽略未渲染，使用...方式声明的参数可以正常渲染，但是没有展示(childre type:xxx)
+ * @param fooBytes 测试Byte数组
+ * @param fooShorts 测试Short数组
+ * @param fooInts 测试Integer数组
+ * @param fooLongs 测试Long数组
+ * @param fooEnums 测试枚举数组（注意，这个类型被直接忽略了未渲染）
+ * @param fooEnums2 使用...的方式声明的枚举数组
+ */
+ void useArray(Byte[] fooBytes, Short[] fooShorts, Integer[] fooInts, Long[] fooLongs, FooEnum[] fooEnums, FooEnum... fooEnums2);
+
+ /**
+ * Use Collections & Collection
+ * @apiNote 当使用List/Set的形式作为入参时 Description中会展示(children type: xxx)
+ * 同样的也存在枚举类型无法渲染的问题
+ * @param fooBytes 测试参数描述
+ * @param fooShorts 测试参数描述
+ * @param fooInts 测试参数描述
+ * @param fooLong 测试参数描述
+ * @param fooDate 测试参数描述
+ * @param fooString 测试参数描述
+ * @param fooEnumList 测试参数描述
+ * @param fooByteSet 测试参数描述
+ * @param fooShortSet 测试参数描述
+ * @param fooIntSet 测试参数描述
+ * @param fooLonSet 测试参数描述
+ * @param fooDatSet 测试参数描述
+ * @param fooStrSet 测试参数描述
+ * @param fooEnumSet 测试参数描述
+ */
+ void useCollection(List fooBytes, List fooShorts, List fooInts, List fooLong, List fooDate, List fooString,
+ List fooEnumList, Set fooByteSet, Set fooShortSet, Set fooIntSet, Set fooLonSet, Set fooDatSet, Set fooStrSet,
+ Set fooEnumSet);
+
+ /**
+ * When Use JSR-303 Annotations
+ * @apiNote 当使用JSR-303的注解时，Description字段会拼接此类注解的描述信息Validate[]中进行显示，
+ * TODO 0x0E 注意：如果使用JSR-303字段，但是不添加描述的话，缺省值不是 No comments Founds 而是 null
+ * @param fooEmail 测试@email字段情况
+ * @param fooRegex 测试@Pattern字段情况
+ * @param fooSize 测试@Size字段情况
+ * @param fooEmailNoComment
+ */
+ void useJsr303(@Email(regexp = ".*")String fooEmail,@Pattern(regexp = ".*")String fooRegex,@Size(max = 10,min = 1) String fooSize,
+ @Email(regexp = ".*") String fooEmailNoComment);
+ /**
+ * Use Html Code At Description Area
+ * @apiNote 可以在参数描述区域使用HTML标签
+ * @param fooStr 此处用来展示参数描述 System.out.println("this is a code snippet");
+ * smart-doc
+ */
+ void useHtmlCode(String fooStr);
+
+
+ /**
+ * When Claim A Description At Class's Parameter Area
+ * @apiNote 在类的参数上的描述使用实例
+ * @param foo 测试对象
+ */
+ void useSelfDefinition(FooDescription foo);
+}
+
diff --git a/src/main/java/com/power/doc/usecase/rpc/api/method/invoke/ParameterNameUseCase.java b/src/main/java/com/power/doc/usecase/rpc/api/method/invoke/ParameterNameUseCase.java
new file mode 100644
index 0000000..08945f9
--- /dev/null
+++ b/src/main/java/com/power/doc/usecase/rpc/api/method/invoke/ParameterNameUseCase.java
@@ -0,0 +1,23 @@
+package com.power.doc.usecase.rpc.api.method.invoke;
+
+import java.util.Map;
+
+/**
+ * PRC.Method.Invoke.Parameter Usecase
+ * @dubbo
+ * @author zongzi
+ */
+public interface ParameterNameUseCase {
+
+
+ /**
+ * Parameter Name
+ * @apiNote 测试字段名称的渲染效果。TODO 0x09 strMap的字段名称为-, 但是作为返回参数时就没有问题，
+ *
+ * @param strMap 测试数组
+ * @param fooStr 测试字段
+ * @param barStr 数组测试字段
+ */
+ void invokeParameterName(Map strMap,String fooStr,String... barStr);
+
+}
diff --git a/src/main/java/com/power/doc/usecase/rpc/api/method/invoke/RequiredUseCase.java b/src/main/java/com/power/doc/usecase/rpc/api/method/invoke/RequiredUseCase.java
new file mode 100644
index 0000000..d1d7379
--- /dev/null
+++ b/src/main/java/com/power/doc/usecase/rpc/api/method/invoke/RequiredUseCase.java
@@ -0,0 +1,33 @@
+package com.power.doc.usecase.rpc.api.method.invoke;
+
+import javax.validation.constraints.NotBlank;
+import javax.validation.constraints.NotEmpty;
+import javax.validation.constraints.NotNull;
+
+import com.power.doc.usecase.rpc.api.pojo.required.RpcBarJsr303;
+
+/**
+ * RPC.Method.Invoke.Required Usecase
+ * @dubbo
+ * @author zongzi
+ */
+public interface RequiredUseCase {
+
+
+ /**
+ * Use JSR-303 Annotation
+ * @apiNote 可以使用@NotNull/@NotEmpty/@NotBlank注解来将参数标识为必传，默认情况下为false（非必传）
+ * @param fooStr 使用@NotNull注解
+ * @param barStr 使用@NotEmpty注解
+ * @param kooStr 使用@NotBlank注解
+ * @param bizStr 未使用注解情况下默认为"非必传"
+ */
+ void useJsr303Tag(@NotNull String fooStr, @NotEmpty String barStr, @NotBlank String kooStr,String bizStr);
+
+ /**
+ * Use JSR-303 Inner Class
+ * @apiNote 同样也可以在实体类中标注JSR-303注解的形式影响Required字段
+ * @param rpcBarJsr303 使用了JSR-303注解的实体类
+ */
+ void useJsr303TagInnerClass(RpcBarJsr303 rpcBarJsr303);
+}
diff --git a/src/main/java/com/power/doc/usecase/rpc/api/method/invoke/SinceFieldUseCase.java b/src/main/java/com/power/doc/usecase/rpc/api/method/invoke/SinceFieldUseCase.java
new file mode 100644
index 0000000..1f977df
--- /dev/null
+++ b/src/main/java/com/power/doc/usecase/rpc/api/method/invoke/SinceFieldUseCase.java
@@ -0,0 +1,20 @@
+package com.power.doc.usecase.rpc.api.method.invoke;
+
+import com.power.doc.usecase.rpc.api.pojo.since.RpcFooSince;
+
+/**
+ * RPC.Method.Invoke.Since Usecase
+ * @dubbo
+ * @author zongzi
+ */
+public interface SinceFieldUseCase {
+
+ /**
+ * Use @since
+ * @apiNote 可以在类的属性注释中使用@since注解来表明开始的版本
+ * @param fooSince 实例SINCE对象
+ *
+ */
+ void useSinceTagAtMethod(RpcFooSince fooSince);
+}
+
diff --git a/src/main/java/com/power/doc/usecase/rpc/api/method/invoke/TypeFieldUseCase.java b/src/main/java/com/power/doc/usecase/rpc/api/method/invoke/TypeFieldUseCase.java
new file mode 100644
index 0000000..14759c2
--- /dev/null
+++ b/src/main/java/com/power/doc/usecase/rpc/api/method/invoke/TypeFieldUseCase.java
@@ -0,0 +1,164 @@
+package com.power.doc.usecase.rpc.api.method.invoke;
+
+
+import java.math.BigDecimal;
+import java.util.ArrayList;
+import java.util.Date;
+import java.util.HashSet;
+import java.util.List;
+import java.util.Map;
+import java.util.Optional;
+import java.util.Set;
+
+import javax.persistence.criteria.CriteriaBuilder;
+
+import com.power.doc.usecase.rest.pojo.type.BarEnum;
+import com.power.doc.usecase.rest.pojo.type.BarType;
+import com.power.doc.usecase.rest.pojo.type.FooCircleDependency;
+import com.power.doc.usecase.rest.pojo.type.FooEnum;
+import com.power.doc.usecase.rpc.api.pojo.type.RpcFooType;
+
+/**
+ * RPC.Method.Invoke.Type Usecase
+ * @dubbo
+ * @author zongzi
+ */
+public interface TypeFieldUseCase {
+
+ /**
+ * Use Basic Type
+ * @apiNote 测试基本类型
+ * @param fooByte
+ * @param fooShor
+ * @param fooInt
+ * @param fooLong
+ * @param fooBool
+ * @param fooChar
+ * @param fooDouble
+ * @param fooFlot
+ */
+ void useBasicTypes(byte fooByte, short fooShor, int fooInt, long fooLong, boolean fooBool, char fooChar, double fooDouble, float fooFlot);
+
+ /**
+ * Use Box Basic Type
+ * @apiNote 测试基本对象的包装类型
+ * @param fooByte 测试Byte
+ * @param fooShort 测试Short
+ * @param fooInt 测试Integer
+ * @param fooLong 测试Long对象
+ * @param fooBool 测试Boolean对象
+ * @param fooChar 测试Character
+ * @param fooDouble 测试Double
+ * @param fooFloat 测试Float
+ * @param fooDate 测试日期对象
+ * @param fooBigDecimal 测试Decimal对象
+ * @param fooString 测试字符串对象
+ * @param fooEnum 测试枚举对象
+ */
+ void useBasicTypesBox(Byte fooByte, Short fooShort, Integer fooInt, Long fooLong, Boolean fooBool, Character fooChar, Double fooDouble, Float fooFloat,
+ Date fooDate, BigDecimal fooBigDecimal,String fooString,FooEnum fooEnum);
+
+
+
+ /**
+ * Use Self-Definition Type
+ * @apiNote 使用自定义类型
+ * @param fooType 自定义测试字段
+ */
+ void selfDefinitionType(RpcFooType fooType);
+
+ /**
+ * Use Optional Api
+ * @apiNote 使用Optional-API 作为入参的场景
+ * @param fooOptional 使用Optional-API
+ */
+ void useOptionalApi(Optional fooOptional);
+ /**
+ * Use Circle Dependence Type
+ * @apiNote 使用自定义的循环依赖乐行
+ * @param fooCircleDependency 自定义的循环依赖对象
+ *
+ */
+ void circleDependencyType(FooCircleDependency fooCircleDependency);
+
+
+
+ /**
+ * Use Array Types
+ * @apiNote 使用BarType[] barsBarType... bars2作为入参时的类型渲染
+ * TODO 0x02 使用...作入参传递时，Invoke-parameters的Type类型和单独传递时无法区分
+ * @param barString 测试字符串列表
+ * @param bars 测试对象列表
+ * @param bars2 测试对象列表
+ *
+ */
+ void arrayTypes(String[] barString, BarType[] bars, BarType... bars2);
+
+ /**
+ * Use Array Enums Types
+ * @apiNote 使用BarEnum[] barEnums,BarEnum... barEnums2作为入参时的类型渲染
+ * TODO 0x07 BarEnum[] 类型的参数被直接忽略
+ * @param barEnums 测试枚举对象列表
+ * @param barEnums2 测试枚举对象列表
+ *
+ */
+ void arrayTypes(BarEnum[] barEnums, BarEnum... barEnums2);
+
+
+ /**
+ * Use Collection Types(List)
+ * @apiNote 使用基本对象类型的集合做为入参时
+ * @param fooString
+ * @param fooBytes
+ * @param fooShorts
+ * @param fooInts
+ * @param fooLong
+ * @param fooEnums TODO 0x0B当时用List时，参数被忽略
+ * @param fooDate
+ *
+ */
+
+ void useCollection(List fooBytes,List fooShorts,List fooInts, List fooLong,List fooEnums,List fooDate,List fooString);
+
+ /**
+ * Use Collection Types(Set)
+ * @param fooBytes
+ * @param fooShorts
+ * @param fooInts
+ * @param fooLong
+ * @param fooEnums TODO 0x0C当时用List时，参数被忽略
+ * @param fooDate
+ * @param fooString
+ */
+ void useCollection(Set fooBytes,Set fooShorts,Set fooInts, Set fooLong,Set fooEnums,Set fooDate,Set fooString);
+
+ /**
+ * Use Collection Types(Self-Definition)
+ * @apiNote TODO 0x03 使用集合对象作为入参时，与单独传递对象时无法区分
+ * TODO 0x06 Set形式的参数在方法签名中被直接忽略
+ * @param barSet 测试对象集合
+ * @param barList 测试对象列表
+ * @param barHashSet 测试对象集合
+ * @param barArrayList 测试对象列表
+ * @param barEnumSet 测试枚举对象集合
+ */
+
+ void collectionTypes(Set barSet, List barList, HashSet barHashSet, ArrayList barArrayList, Set barEnumSet);
+
+ /**
+ * Use Map Types
+ * @apiNote TODO 0x05 使用Map作为入参对象时的问题列表
+ *
+ * strMap返回的参数名被忽略，description中返回String类型
+ * barMap字段的Type类型问题
+ * 如果Map的key不是String，在渲染的文档中无法显示
+ * enumMap被直接忽略
+ *
+ * @param strMap Map
+ * @param barMap Map
+ * @param enumBarMap Map
+ * @param enumMap Map
+ */
+ void mapTypes(Map strMap, Map barMap, Map enumBarMap, Map enumMap);
+}
+
diff --git a/src/main/java/com/power/doc/usecase/rpc/api/method/meta/DefinitionUseCase.java b/src/main/java/com/power/doc/usecase/rpc/api/method/meta/DefinitionUseCase.java
new file mode 100644
index 0000000..a2f874d
--- /dev/null
+++ b/src/main/java/com/power/doc/usecase/rpc/api/method/meta/DefinitionUseCase.java
@@ -0,0 +1,48 @@
+package com.power.doc.usecase.rpc.api.method.meta;
+
+import javax.validation.constraints.NotNull;
+
+import com.power.doc.usecase.rest.pojo.type.FooType;
+import com.power.doc.usecase.rpc.api.pojo.description.FooDescription;
+
+/**
+ * RPC.Method.Meta.Definition Usecase
+ * @author zongzi
+ * @dubbo
+ */
+public interface DefinitionUseCase {
+
+ /**
+ * Default Method Definition
+ * @apiNote 定义一栏来源于方法的定义。
+ */
+ void definitionComeFromMethod();
+
+
+ /**
+ * Maintain The Param Name
+ * @apiNote 注意：方法参数列表中的参数名也可以在Definition这一栏被维护
+ * @param fooInts 测试字段名称
+ */
+ void alsoMaintainTheParamName(@NotNull Integer fooInt);
+
+ /**
+ * When Use Arrays
+ * @apiNote 当使用(String[] fooStrings,Integer... fooInts传递参数时
+ * TODO 0x08 当时用...作为入参时，Definition中显示的是单个长度，查看:void whenPassArrays(String[] fooStrings, Integer fooInts)
+ * @param fooStrings 测试字符串入参
+ * @param fooInts 测试入参
+ */
+ void whenPassArrays(String[] fooStrings,Integer... fooInts);
+
+
+ /**
+ * Return Arrays
+ * @apiNote TODO 0x15 当返回对象是数组时，Definition将数组标识丢弃了
+ * 此处的方法声明是FooType[] returnArrayObjects();,
+ * 但是展示内容是 FooType returnArrayObjects()
+ * @return 返回对象列表
+ */
+ FooType[] returnArrayObjects();
+
+}
diff --git a/src/main/java/com/power/doc/usecase/rpc/api/method/meta/DescriptionUseCase.java b/src/main/java/com/power/doc/usecase/rpc/api/method/meta/DescriptionUseCase.java
new file mode 100644
index 0000000..8f8f138
--- /dev/null
+++ b/src/main/java/com/power/doc/usecase/rpc/api/method/meta/DescriptionUseCase.java
@@ -0,0 +1,49 @@
+package com.power.doc.usecase.rpc.api.method.meta;
+
+/**
+ * PRC.Method.Meta.Description Usecase
+ * @dubbo
+ * @author zongzi
+ * @version 2.5.3
+ */
+public interface DescriptionUseCase {
+
+ /**
+ * Show Method Description
+ * @apiNote 方法上的@apiNote之后的内容会被添加Description这一栏，缺省为空
+ * 在这一栏中的HTML代码会被正常渲染
+ *
+ * first
+ * second
+ *
+ *
+ * System.out.println("this is a code snippet");
+ *
+ * This is a Tag:i
+ * 使用Tag:i渲染中文
+ * 使用渲染中文
+ * This is a Tag:b
+ * 使用Tag:b渲染中文
+ * 使用渲染中文
+ * This is a Tag:u
+ * 使用Tag:u渲染中文
+ * 使用渲染中文
+ * This a Tag:a
+ * 使用Tag:a渲染中文
+ *
+ * TODO 0x0D 以下HTML标签无法渲染
+ */
+ void showDescription();
+
+
+ /**
+ * Use <> AS API Name Or < >
+ * @apiNote <....> <<<<<<>>>>>>> This is a Code Snippet
+ * TODO 0x04 当代码API的名称中出现<>，或者< >，渲染结果全部被替换为了对应的转义字符，这和HTML模版中的不一致,可读性也下降了
+ *
+ */
+ void useHtmlCodeAsMethodComment();
+
+
+
+}
diff --git a/src/main/java/com/power/doc/usecase/rpc/api/method/reponse/DescriptionUseCase.java b/src/main/java/com/power/doc/usecase/rpc/api/method/reponse/DescriptionUseCase.java
new file mode 100644
index 0000000..062eafb
--- /dev/null
+++ b/src/main/java/com/power/doc/usecase/rpc/api/method/reponse/DescriptionUseCase.java
@@ -0,0 +1,65 @@
+package com.power.doc.usecase.rpc.api.method.reponse;
+
+
+import java.util.List;
+import java.util.Map;
+
+
+import com.power.doc.usecase.rest.pojo.result.FooResult;
+import com.power.doc.usecase.rest.pojo.type.FooEnum;
+import com.power.doc.usecase.rpc.api.pojo.description.FooDescription;
+
+/**
+ * RPC.Method.Response.Description Usecase
+ * @author zongzi
+ * @dubbo
+ */
+public interface DescriptionUseCase {
+
+
+ /**
+ * Return Self-Definition
+ * @apiNote 返回值的Description来源于对象属性注释
+ * @return 示例描述对象
+ */
+ FooDescription selfDefinition();
+
+
+ /**
+ * Return Lists
+ * @apiNote 返回值为列表时的参数描述
+ * @return 示例描述对象
+ */
+ List returnListObjects();
+
+
+ /**
+ * Return Maps
+ * @apiNote 当返回值是Map时，出现mapKey字样，并且描述内容来源于Map<K,V>中V的类注释。
+ * @return 示例参数描述
+ */
+ Map returnMaps();
+
+ /**
+ * Return Map
+ * @apiNote 当返回值是Map<String,String>,出现mapKey字样，并且Description被固定为A map key
+ * @return 示例参数描述
+ */
+ Map returnMaps2();
+
+ /**
+ * Return Map With Enum
+ * @apiNote TODO 0x13 当返回Map中的Value为枚举对象时，Description一栏中没有给出枚举值内容
+ * @return 示例参数描述
+ */
+ Map returnEnumMap();
+
+
+ /**
+ * Return Self Generic Type
+ * @apiNote 当返回自定义的泛型封装对象时，注解来源于两者的属性上注解
+ * @return
+ */
+ FooResult returnSelfGenericType();
+}
+
diff --git a/src/main/java/com/power/doc/usecase/rpc/api/method/reponse/FieldNameUseCase.java b/src/main/java/com/power/doc/usecase/rpc/api/method/reponse/FieldNameUseCase.java
new file mode 100644
index 0000000..5d4e9fe
--- /dev/null
+++ b/src/main/java/com/power/doc/usecase/rpc/api/method/reponse/FieldNameUseCase.java
@@ -0,0 +1,36 @@
+package com.power.doc.usecase.rpc.api.method.reponse;
+
+import java.util.List;
+import java.util.Map;
+
+
+/**
+ * RPC.Method.Response.Field Usecase
+ * @dubbo
+ * @author zongzi
+ */
+public interface FieldNameUseCase {
+
+ /**
+ * Return Map
+ * @apiNote TODO 0x19 同时使用 Map时，入参形式和上一个相同，无法区分，只能通过Definition区分。
+ * @param foo 测试对象
+ * @return
+ */
+ Map returnStringMap(Map foo);
+
+ /**
+ * Return Map>
+ * @apiNote TODO 0x18 同时使用 Map>时，Invoke-Parameters和Response-fields的展示逻辑不同。
+ * @param foo 测试对象
+ * @return
+ */
+ Map> returnStringWithListString(Map> foo);
+
+ /**
+ * Return List>
+ * @param foo 测试对象
+ * @return
+ */
+ List> returnStringWithListString(List> foo);
+}
diff --git a/src/main/java/com/power/doc/usecase/rpc/api/method/reponse/SinceFieldUseCase.java b/src/main/java/com/power/doc/usecase/rpc/api/method/reponse/SinceFieldUseCase.java
new file mode 100644
index 0000000..8f5c2e8
--- /dev/null
+++ b/src/main/java/com/power/doc/usecase/rpc/api/method/reponse/SinceFieldUseCase.java
@@ -0,0 +1,21 @@
+package com.power.doc.usecase.rpc.api.method.reponse;
+
+import com.power.doc.usecase.rpc.api.pojo.since.RpcFooSince;
+
+/**
+ * RPC.Method.Response.Since Usecase
+ * @dubbo
+ * @author zongzi
+ *
+ */
+public interface SinceFieldUseCase {
+
+
+ /**
+ * Use @since
+ * @apiNote 可以在类的属性注释中使用@since注解来表明开始的版本
+ *
+ * @return
+ */
+ RpcFooSince useSinceTagAtMethod();
+}
diff --git a/src/main/java/com/power/doc/usecase/rpc/api/method/reponse/TypeFieldUseCase.java b/src/main/java/com/power/doc/usecase/rpc/api/method/reponse/TypeFieldUseCase.java
new file mode 100644
index 0000000..433fcf8
--- /dev/null
+++ b/src/main/java/com/power/doc/usecase/rpc/api/method/reponse/TypeFieldUseCase.java
@@ -0,0 +1,163 @@
+package com.power.doc.usecase.rpc.api.method.reponse;
+
+import java.util.Date;
+import java.util.List;
+import java.util.Map;
+import java.util.Set;
+
+import javax.persistence.criteria.CriteriaBuilder;
+
+import com.power.doc.usecase.rest.pojo.result.FooResult;
+import com.power.doc.usecase.rest.pojo.type.FooEnum;
+import com.power.doc.usecase.rpc.api.pojo.type.RpcFooType;
+
+/**
+ * RPC.Method.Response.Type Usecase
+ * @author zongzi
+ * @dubbo
+ */
+public interface TypeFieldUseCase {
+
+
+ /**
+ * Return Basic Type
+ * @apiNote TODO 0x0F 当返回简单类型时，Response-fields一栏未被展示
+ * @return Integer 测试返回简单类型的描述
+ */
+ Integer returnBasicType();
+
+ /**
+ * Return Basic Type Array
+ * @apiNote TODO 0x17 返回简单类型的列表，Definition一栏展示错误
+ * @return 示例描述对象
+ */
+ Integer[] returnBasicTypeArray();
+ /**
+ * Return Basic Type List
+ * @apiNote TODO 0x16 返回简单类型的列表，Response-fields一栏未被展示
+ * @return 示例描述对象
+ */
+ List returnBasicTypeList();
+ /**
+ * Return Basic Type Lists
+ * @apiNote TODO 0x10 返回简单类型集合，Response-fields一栏未被展示
+ * @return 示例描述对象
+ */
+ Set returnBasicTypeSet();
+
+ /**
+ * Return String Map
+ * @return
+ */
+ Map returnStringMap();
+ /**
+ * Return Basic Type With Generic
+ * @apiNote TODO 0x17 使用泛型封装Integer时，返回的type为int32,而不是像其他一样是包装类型的全路径
+ * @return
+ */
+ FooResult returnBasicTypeWithGeneric();
+
+
+ /**
+ * Return Basic Type List With Generic
+ * @return
+ */
+ FooResult> returnBasicTypeListWithGeneric();
+
+
+ /**
+ * Return Basic Type List Map With Generic
+ * @return
+ */
+ FooResult>> returnBasicTypeListMapWithGeneric();
+
+
+ /**
+ * Return Basic Type Map List With Generic
+ * @return
+ */
+ FooResult>> returnBasicTypeMapListWithGeneric();
+ /**
+ * Return Enum
+ * @apiNote TODO 0x11 返回枚举对象时，Response-fields一栏未被展示
+ * @return 示例描述对象
+ */
+ FooEnum returnEnum();
+
+ /**
+ * Return Enum Array
+ * @return
+ */
+ FooEnum[] returnEnumArray();
+
+ /**
+ * Return Enum List
+ * @apiNote TODO 0x12 返回枚举对象列表时，Response-fields一栏未被展示
+ * @return 示例描述对象
+ */
+ List returnEnumList();
+
+ /**
+ * Return Enums Set
+ * @apiNote TODO 0x14 返回枚举对象集合时，Response-fields一栏未被展示
+ * @return 示例返回类型
+ */
+ Set returnEnumSet();
+
+ /**
+ * Return Enum Map
+ * @apiNote TODO 0x16 返回枚举的Map时，没有展示枚举的相信信息
+ * @return
+ */
+ Map returnEnumMap();
+ /**
+ * Return Enum With Generic Type
+ * @apiNote TODO 0x15 使用泛型返回枚举对象是, Data的Type类型是 object,没有展示泛型内容
+ * @return
+ */
+ FooResult returnEnumWithGeneric();
+
+ /**
+ * Return Self-Definition Type
+ * @apiNote 返回自定义对象列表
+ * @return 示例测试对象
+ */
+ RpcFooType returnSelfDefinition();
+
+ /**
+ * Return Foo Array
+ * @return
+ */
+ RpcFooType[] returnFooTypeArray();
+
+ /**
+ * Return Foo List
+ * @return
+ */
+ List returnFooTypeList();
+
+ /**
+ * Return Foo Set
+ * @return
+ */
+ Set returnFooTypeSet();
+
+ /**
+ * Return Foo Map
+ * @return
+ */
+ Map returnFooTypeMap();
+ /**
+ * Return Foo With Generic
+ * @return
+ */
+ FooResult returnFooTypeWithGeneric();
+
+
+ /**
+ * Return Foo List With Generic
+ * @return
+ */
+ FooResult> returnFooTypeListWithGeneric();
+
+}
diff --git a/src/main/java/com/power/doc/usecase/rpc/api/pojo/description/FooDescription.java b/src/main/java/com/power/doc/usecase/rpc/api/pojo/description/FooDescription.java
new file mode 100644
index 0000000..349b43f
--- /dev/null
+++ b/src/main/java/com/power/doc/usecase/rpc/api/pojo/description/FooDescription.java
@@ -0,0 +1,29 @@
+package com.power.doc.usecase.rpc.api.pojo.description;
+
+import lombok.Data;
+
+/**
+ * 参数描述示例对象
+ * @author zongzi
+ */
+@Data
+public class FooDescription {
+
+ /**
+ * 属性参数描述1
+ *
+ * System.out.println("Smart-Doc");
+ *
+ *
+ */
+ String fooStr;
+
+
+ /**
+ * 属性参数描述2
+ * 但是包含HTML标签，因此需要在编写注释时进行转义。
+ * 1. List
+ * 2. This is a Tag:b
+ */
+ String barStr;
+}
diff --git a/src/main/java/com/power/doc/usecase/rpc/api/pojo/required/RpcBarJsr303.java b/src/main/java/com/power/doc/usecase/rpc/api/pojo/required/RpcBarJsr303.java
new file mode 100644
index 0000000..ece7b9f
--- /dev/null
+++ b/src/main/java/com/power/doc/usecase/rpc/api/pojo/required/RpcBarJsr303.java
@@ -0,0 +1,108 @@
+package com.power.doc.usecase.rpc.api.pojo.required;
+
+import java.util.Date;
+import java.util.List;
+
+import javax.validation.constraints.AssertFalse;
+import javax.validation.constraints.AssertTrue;
+import javax.validation.constraints.DecimalMax;
+import javax.validation.constraints.DecimalMin;
+import javax.validation.constraints.Digits;
+import javax.validation.constraints.Email;
+import javax.validation.constraints.Future;
+import javax.validation.constraints.FutureOrPresent;
+import javax.validation.constraints.Max;
+import javax.validation.constraints.Min;
+import javax.validation.constraints.Negative;
+import javax.validation.constraints.NegativeOrZero;
+import javax.validation.constraints.NotBlank;
+import javax.validation.constraints.NotEmpty;
+import javax.validation.constraints.NotNull;
+import javax.validation.constraints.Null;
+import javax.validation.constraints.Past;
+import javax.validation.constraints.PastOrPresent;
+import javax.validation.constraints.Pattern;
+import javax.validation.constraints.Positive;
+import javax.validation.constraints.PositiveOrZero;
+import javax.validation.constraints.Size;
+
+import lombok.Data;
+
+/**
+ * 测试JSR-303标准注解
+ * @author zongzi
+ */
+@Data
+public class RpcBarJsr303 {
+ @NotNull
+ String barNotNullString;
+
+ @NotBlank
+ String barNotBlankString;
+
+ @NotEmpty
+ String barNotEmptyString;
+
+ @Null
+ String barMustNullString;
+
+ @AssertTrue
+ Boolean barMustTureBool;
+
+ @AssertFalse
+ Boolean barMustFalseBool;
+
+ @PositiveOrZero
+ Integer barPositiveOrZeroInt;
+
+ @Positive
+ Integer barPositiveInt;
+
+ @NegativeOrZero
+ Integer barNegativeOrZeroInt;
+
+ @Negative
+ Integer barNegativeInt;
+
+
+ @Min(10)
+ int barMinInt;
+
+ @Max(11)
+ int barMaxInt;
+
+ @DecimalMin("10")
+ Long barMinDecimal;
+
+ @DecimalMax("100")
+ Long barMaxDecimal;
+
+
+ @Size(min = 3, max = 4)
+ String barSizeString;
+
+ @Size(min = 3, max = 4)
+ List barSizeStringArray;
+
+ @Digits(integer = 100, fraction = 99)
+ Double barDigitsDouble;
+
+ @Past
+ Date barPastDate;
+ @PastOrPresent
+ Date barPastOrPresent;
+
+ @Future
+ Date barFutureDate;
+ @FutureOrPresent
+ Date barFutureOrPresentDate;
+
+ @Pattern(regexp = ".*")
+ String barPatternStringWithComment;
+
+ @Pattern(regexp = ".*")
+ String barPatternString;
+
+ @Email(regexp = ".*")
+ String barEmailString;
+}
diff --git a/src/main/java/com/power/doc/usecase/rpc/api/pojo/since/RpcFooSince.java b/src/main/java/com/power/doc/usecase/rpc/api/pojo/since/RpcFooSince.java
new file mode 100644
index 0000000..683348f
--- /dev/null
+++ b/src/main/java/com/power/doc/usecase/rpc/api/pojo/since/RpcFooSince.java
@@ -0,0 +1,35 @@
+package com.power.doc.usecase.rpc.api.pojo.since;
+
+import lombok.Data;
+
+@Data
+public class RpcFooSince {
+ /**
+ * 从1.0.0版本开始
+ * @since 1.0.0
+ */
+ String fooStr;
+ /**
+ * 从1.0.1版本开始
+ * @since 1.0.1
+ */
+ Integer fooInt;
+ /**
+ * 从1.0.2,1.0.3版本开始
+ * @since 1.0.2
+ * @since 1.0.3
+ */
+ Enum fooEnum;
+
+ /**
+ * 从2.5.3版本开始
+ * @since 2.5.3
+ */
+ Double fooDouble;
+
+ /**
+ * 从@#$%^&*(!!!版本开始
+ * @since @#$%^&*(!!!
+ */
+ Long fooLong;
+}
diff --git a/src/main/java/com/power/doc/usecase/rpc/api/pojo/type/RpcFooType.java b/src/main/java/com/power/doc/usecase/rpc/api/pojo/type/RpcFooType.java
new file mode 100644
index 0000000..d9490a7
--- /dev/null
+++ b/src/main/java/com/power/doc/usecase/rpc/api/pojo/type/RpcFooType.java
@@ -0,0 +1,55 @@
+package com.power.doc.usecase.rpc.api.pojo.type;
+
+import java.math.BigDecimal;
+import java.util.Date;
+import java.util.List;
+import java.util.Map;
+
+import com.power.doc.usecase.rest.pojo.type.BarType;
+import com.power.doc.usecase.rest.pojo.type.FooEnum;
+import lombok.Data;
+
+/**
+ * 测试RPC对象类型
+ */
+@Data
+public class RpcFooType {
+ Boolean fooBooleanInBox;
+ boolean fooBoolean;
+ Character fooCharInBox;
+ char fooChar;
+ Double fooDoubleInBox;
+ double foolDouble;
+ Float fooFloatInBox;
+ float fooFloat;
+ Byte fooByteInBox;
+ byte fooByte;
+ Short fooShortInBox;
+ short foolShort;
+ Integer fooIntInBox;
+ int foolInt;
+ Long fooLongInBox;
+ long fooLong;
+ String fooString;
+ BigDecimal fooBigDecimal;
+ Date foolDate;
+ BarType bar;
+ boolean[] fooBooleanArray;
+ char[] fooCharArray;
+ float[] fooFloatArray;
+ double[] fooDoubleArray;
+ byte[] fooByteArray;
+ short[] fooShortArray;
+ int[] fooIntArray;
+ long[] fooLongArray;
+ String[] fooStringArray;
+ BarType[] fooBarArray;
+ List fooStringList;
+ List fooBarList;
+ Map foolStringIntegerMap;
+ Map foolStringBarMap;
+ FooEnum fooEnum;
+ FooEnum[] fooEnumArray;
+ List fooEnumList;
+ Map fooEnumMap;
+}
diff --git a/src/main/resources/smart-doc.json b/src/main/resources/smart-doc.json
index 1ad2026..db0716c 100644
--- a/src/main/resources/smart-doc.json
+++ b/src/main/resources/smart-doc.json
@@ -5,7 +5,7 @@
"allInOne": true,
"coverOld": true,
"createDebugPage": true,
- "style":"xt256",
+ "style": "xt256",
"packageFilters": "",
"appKey": "20210318821914523354005504",
"appToken": "17081fb20b1546a196121e781d3c6d01",
@@ -16,74 +16,184 @@
"tornaDebug": true,
"inlineEnum": true,
"skipTransientField": true,
- "requestHeaders": [ //设置请求头，没有需求可以不设置
- {
- "name": "token",//请求头名称
- "type": "string",//请求头类型
- "desc": "desc",//请求头描述信息
- "value":"kk",//不设置默认null
- "required": false,//是否必须
- "since": "-" //什么版本添加的改请求头
+ "requestHeaders": [
+ //设置请求头，没有需求可以不设置
+ {
+ "name": "token",
+ //请求头名称
+ "type": "string",
+ //请求头类型
+ "desc": "desc",
+ //请求头描述信息
+ "value": "kk",
+ //不设置默认null
+ "required": false,
+ //是否必须
+ "since": "-",
+ // 什么版本添加的改请求头
+ "pathPatterns": "/InnovateFruit/**"
+ // "excludePathPatterns": "/app/login" // 登录url=/app/page/将不会有该请求头
+ },
+ {
+ "name": "global-headers",
+ "type": "string",
+ "desc": "desc",
+ //请求头描述信息
+ "value": "any string",
+ //不设置默认null
+ "required": false,
+ //是否必须
+ "since": "2.5.3",
+ //什么版本添加的改请求头
+ "pathPatterns": "/headers/*",
+ "excludePathPatterns": "/headers/set-exclude-header"
+ },
+ {
+ "name": "specific-headers",
+ "type": "string",
+ "desc": "desc",
+ //请求头描述信息
+ "value": "any string",
+ //不设置默认null
+ "required": false,
+ //是否必须
+ "since": "2.5.3",
+ //什么版本添加的改请求头
+ "pathPatterns": "/headers/set-specific-header"
}
],
- "requestParams": [ //设置请求头，没有需求可以不设置
- {
- "name": "configPathParam",//请求头名称
- "type": "string",//请求头类型
- "desc": "desc",//请求头描述信息
- "paramIn": "path", // 参数所在位置 header-请求头, path-路径参数, query-参数
- "value":"testPath",//不设置默认null
- "required": false,//是否必须
- "since": "-",//什么版本添加的改请求头
- "pathPatterns": "*"//正则表达式过滤请求头
+ "requestParams": [
+ //设置请求头，没有需求可以不设置
+ {
+ "name": "configPathParam",
+ //请求头名称
+ "type": "string",
+ //请求头类型
+ "desc": "desc",
+ //请求头描述信息
+ "paramIn": "path",
+ // 参数所在位置 header-请求头, path-路径参数, query-参数
+ "value": "testPath",
+ //不设置默认null
+ "required": false,
+ //是否必须
+ "since": "-",
+ //什么版本添加的改请求头
+ "pathPatterns": "*"
+ //正则表达式过滤请求头
},
{
- "name": "configQueryParam",//请求头名称
- "type": "string",//请求头类型
- "desc": "desc",//请求头描述信息
+ "name": "configQueryParam",
+ //请求头名称
+ "type": "string",
+ //请求头类型
+ "desc": "desc",
+ //请求头描述信息
"paramIn": "query",
- "value":"testQuery",//不设置默认null
- "required": false,//是否必须
- "since": "-",//什么版本添加的改请求头
- "pathPatterns": "*"//正则表达式过滤请求头
+ "value": "testQuery",
+ //不设置默认null
+ "required": false,
+ //是否必须
+ "since": "-",
+ //什么版本添加的改请求头
+ "pathPatterns": "*"
+ //正则表达式过滤请求头
+ }
+ ],
+ "errorCodeDictionaries": [
+ {
+ //错误码列表，没有需求可以不设置
+ "title": "title",
+ "enumClassName": "com.power.common.enums.HttpCodeEnum",
+ //错误码枚举类,如果是枚举是在一个类中定义则用$链接类BaseErrorCode$Common
+ "codeField": "code",
+ //错误码的code码字段名称
+ "descField": "message"
+ //错误码的描述信息对应的字段名
+ }
+ ],
+ "rpcApiDependencies": [
+ {
+ // 项目开放的dubbo api接口模块依赖，配置后输出到文档方便使用者集成
+ "artifactId": "SpringBoot2-Dubbo-Api",
+ "groupId": "com.demo",
+ "version": "1.0.0"
+ }
+ ],
+ "apiConstants": [
+ {
+ "constantsClassName": "com.power.doc.constants.RequestParamConstant"
+ },
+ {
+ "constantsClassName": "com.power.doc.constants.RequestValueConstant"
+ },
+ {
+ "constantsClassName": "com.power.doc.constants.ApiVersion"
+ },
+ {
+ "constantsClassName": "com.power.doc.constants.RequestHeadValue"
+ },
+ {
+ "constantsClassName": "org.springframework.http.HttpHeaders"
+ }
+ ],
+ "dataDictionaries": [
+ {
+ //配置数据字典，没有需求可以不设置
+ "title": "http状态码字典",
+ //数据字典的名称
+ "enumClassName": "com.power.common.enums.HttpCodeEnum",
+ //数据字典枚举类名称
+ "codeField": "code",
+ //数据字典字典码对应的字段名称
+ "descField": "message"
+ //数据字典对象的描述信息字典
}
],
- "errorCodeDictionaries": [{ //错误码列表，没有需求可以不设置
- "title": "title",
- "enumClassName": "com.power.common.enums.HttpCodeEnum", //错误码枚举类,如果是枚举是在一个类中定义则用$链接类BaseErrorCode$Common
- "codeField": "code",//错误码的code码字段名称
- "descField": "message"//错误码的描述信息对应的字段名
- }],
-
- "rpcApiDependencies":[{ // 项目开放的dubbo api接口模块依赖，配置后输出到文档方便使用者集成
- "artifactId":"SpringBoot2-Dubbo-Api",
- "groupId":"com.demo",
- "version":"1.0.0"
- }],
- "apiConstants":[{
- "constantsClassName":"com.power.doc.constants.RequestParamConstant"
- }, {
- "constantsClassName":"com.power.doc.constants.RequestValueConstant"
- }, {
- "constantsClassName":"com.power.doc.constants.ApiVersion"
- },{
- "constantsClassName":"com.power.doc.constants.RequestHeadValue"
- }, {
- "constantsClassName": "org.springframework.http.HttpHeaders"
- }],
- "dataDictionaries": [{ //配置数据字典，没有需求可以不设置
- "title": "http状态码字典", //数据字典的名称
- "enumClassName": "com.power.common.enums.HttpCodeEnum", //数据字典枚举类名称
- "codeField": "code",//数据字典字典码对应的字段名称
- "descField": "message"//数据字典对象的描述信息字典
- }],
"customRequestFields": [
- {"name":"start", "ownerClassName":"com.gitee.fastmybatis.core.query.param.PageParam", "value":"0", "required":false,"ignore":true}
- ,{"name":"limit", "ownerClassName":"com.gitee.fastmybatis.core.query.param.PageParam", "value":"0", "required":false,"ignore":true}
+ {
+ "name": "start",
+ "ownerClassName": "com.gitee.fastmybatis.core.query.param.PageParam",
+ "value": "0",
+ "required": false,
+ "ignore": true
+ },
+ {
+ "name": "limit",
+ "ownerClassName": "com.gitee.fastmybatis.core.query.param.PageParam",
+ "value": "0",
+ "required": false,
+ "ignore": true
+ }
],
- "groups": [ // @since 2.2.5, 对不同的controller进行分组
+ "groups": [
+ {
+ "name": "API Meta Info Usecase",
+ "apis": "com.power.doc.usecase.rest.api.meta.*"
+ },
+ {
+ "name": "Path Parameters Usecase",
+ "apis": "com.power.doc.usecase.rest.api.path.parameter.*"
+ },
+ {
+ "name": "Request Headers Usecase",
+ "apis": "com.power.doc.usecase.rest.api.headers.*"
+ },
+ {
+ "name": "Query Parameters Usecase",
+ "apis": "com.power.doc.usecase.rest.api.query.parameter.*"
+ },
+ {
+ "name": "Body Parameters Usecase",
+ "apis": "com.power.doc.usecase.rest.api.body.parameter.*"
+ },
+ {
+ "name": "Response Fields Usecase",
+ "apis": "com.power.doc.usecase.rest.api.response.*"
+ },
{
"name": "测试分组",
+ // @since 2.2.5, 对不同的controller进行分组
"apis": "com.power.doc.controller.*"
}
]