优化代码

java110-doc/src/main/java/com/java110/doc/annotation/Java110CmdDoc.java

@@ -40,5 +40,7 @@ public @interface Java110CmdDoc {
      */
     String url();
 
+    String author() default "";
+
 
 }

java110-doc/src/main/java/com/java110/doc/annotation/Java110ExampleDoc.java

@@ -0,0 +1,15 @@
+package com.java110.doc.annotation;
+
+import java.lang.annotation.ElementType;
+import java.lang.annotation.Retention;
+import java.lang.annotation.RetentionPolicy;
+import java.lang.annotation.Target;
+
+@Target(ElementType.TYPE)
+@Retention(RetentionPolicy.RUNTIME)
+public @interface Java110ExampleDoc {
+
+    String reqBody() default "";
+
+    String resBody() default "";
+}

java110-doc/src/main/java/com/java110/doc/annotation/Java110HeaderDoc.java

@@ -1,5 +1,12 @@
 package com.java110.doc.annotation;
 
+import java.lang.annotation.ElementType;
+import java.lang.annotation.Retention;
+import java.lang.annotation.RetentionPolicy;
+import java.lang.annotation.Target;
+
+@Target(ElementType.TYPE)
+@Retention(RetentionPolicy.RUNTIME)
 public @interface Java110HeaderDoc {
 
     String name();

java110-doc/src/main/java/com/java110/doc/annotation/Java110ParamDoc.java

@@ -1,8 +1,23 @@
 package com.java110.doc.annotation;
 
-import java.lang.reflect.Array;
+import java.lang.annotation.ElementType;
+import java.lang.annotation.Retention;
+import java.lang.annotation.RetentionPolicy;
+import java.lang.annotation.Target;
 
+@Target(ElementType.TYPE)
+@Retention(RetentionPolicy.RUNTIME)
 public @interface Java110ParamDoc {
 
-    String[] headers();
+    String parentNodeName() default "-";
+
+    String name();
+
+    String type() default "String";
+
+    int length() default 0;
+
+    String defaultValue() default "";
+
+    String remark() default "";
 }

java110-doc/src/main/java/com/java110/doc/annotation/Java110ParamsDoc.java

@@ -0,0 +1,17 @@
+package com.java110.doc.annotation;
+
+import java.lang.annotation.ElementType;
+import java.lang.annotation.Retention;
+import java.lang.annotation.RetentionPolicy;
+import java.lang.annotation.Target;
+
+@Target(ElementType.TYPE)
+@Retention(RetentionPolicy.RUNTIME)
+public @interface Java110ParamsDoc {
+
+    Java110HeaderDoc[] headers() default @Java110HeaderDoc(name = "");
+
+    Java110ParamDoc[] params() default @Java110ParamDoc(name = "");
+
+
+}

java110-doc/src/main/java/com/java110/doc/annotation/Java110RequestMappingDoc.java

@@ -0,0 +1,19 @@
+package com.java110.doc.annotation;
+
+import java.lang.annotation.ElementType;
+import java.lang.annotation.Retention;
+import java.lang.annotation.RetentionPolicy;
+import java.lang.annotation.Target;
+
+@Target(ElementType.TYPE)
+@Retention(RetentionPolicy.RUNTIME)
+public @interface Java110RequestMappingDoc {
+
+    String name();
+
+    String resource() ;
+
+    String url();
+
+    String startWay() default "cloud";
+}

java110-doc/src/main/java/com/java110/doc/annotation/Java110RequestMappingsDoc.java

@@ -0,0 +1,14 @@
+package com.java110.doc.annotation;
+
+
+import java.lang.annotation.ElementType;
+import java.lang.annotation.Retention;
+import java.lang.annotation.RetentionPolicy;
+import java.lang.annotation.Target;
+
+@Target(ElementType.TYPE)
+@Retention(RetentionPolicy.RUNTIME)
+public @interface Java110RequestMappingsDoc {
+
+    Java110RequestMappingDoc[] mappingsDocs() default @Java110RequestMappingDoc(resource = "",ur = "");
+}

java110-doc/src/main/java/com/java110/doc/annotation/Java110ResponseDoc.java

@@ -13,11 +13,9 @@ import java.lang.annotation.Target;
 public @interface Java110ResponseDoc {
 
 
-    /**
-     * request param
-     *
-     * parent|name|type|length|detail|example
-     * @return
-     */
-    String[] params();
+    Java110HeaderDoc[] headers() default @Java110HeaderDoc(name = "");
+
+    Java110ParamDoc[] params() default @Java110ParamDoc(name = "");
+
+
 }

java110-service/pom.xml

@@ -137,6 +137,11 @@
             <artifactId>springfox-swagger-ui</artifactId>
         </dependency>
 
+        <dependency>
+            <groupId>com.java110</groupId>
+            <artifactId>java110-doc</artifactId>
+        </dependency>
+
 <!--        <dependency>-->
 <!--            <groupId>org.springframework.cloud</groupId>-->
 <!--            <artifactId>spring-cloud-starter-zipkin</artifactId>-->

pom.xml

@@ -164,6 +164,12 @@
                 <artifactId>java110-db</artifactId>
                 <version>${microcommunity.version}</version>
             </dependency>
+
+            <dependency>
+                <groupId>com.java110</groupId>
+                <artifactId>java110-doc</artifactId>
+                <version>${microcommunity.version}</version>
+            </dependency>
             <!-- logback 日志组件支持  -->
 
             <dependency>

service-api/src/main/java/com/java110/api/rest/RestApi.java

@@ -4,6 +4,9 @@ import com.alibaba.fastjson.JSONObject;
 import com.java110.api.smo.IApiServiceSMO;
 import com.java110.core.base.controller.BaseController;
 import com.java110.core.log.LoggerFactory;
+import com.java110.doc.annotation.Java110ApiDoc;
+import com.java110.doc.annotation.Java110RequestMappingDoc;
+import com.java110.doc.annotation.Java110RequestMappingsDoc;
 import com.java110.intf.user.IUserInnerServiceSMO;
 import com.java110.utils.constant.CommonConstant;
 import com.java110.vo.ResultVo;
@@ -29,6 +32,28 @@ import java.util.Map;
 @RestController
 @RequestMapping(path = "/api")
 @Api(value = "对外统一提供服务接口服务")
+@Java110ApiDoc(
+        title = "HC小区管理系统api接口文档",
+        description = "HC小区管理系统api接口文档",
+        company="Java110工作室",
+        version = "v1.4"
+)
+
+@Java110RequestMappingsDoc(
+        mappingsDocs = {
+                @Java110RequestMappingDoc(name="账户中心",resource = "acct",url="http://service-acct"),
+                @Java110RequestMappingDoc(name="通用中心",resource = "common",url="http://service-common"),
+                @Java110RequestMappingDoc(name="小区中心",resource = "community",url="http://service-community"),
+                @Java110RequestMappingDoc(name="开发中心",resource = "dev",url="http://service-dev"),
+                @Java110RequestMappingDoc(name="费用中心",resource = "fee",url="http://service-fee"),
+                @Java110RequestMappingDoc(name="定时任务",resource = "job",url="http://service-job"),
+                @Java110RequestMappingDoc(name="oa",resource = "oa",url="http://service-oa"),
+                @Java110RequestMappingDoc(name="订单中心",resource = "order",url="http://service-order"),
+                @Java110RequestMappingDoc(name="报表中心",resource = "report",url="http://service-report"),
+                @Java110RequestMappingDoc(name="商户中心",resource = "store",url="http://service-store"),
+                @Java110RequestMappingDoc(name="用户中心",resource = "user",url="http://service-user"),
+        }
+)
 public class RestApi extends BaseController {
 
     private static Logger logger = LoggerFactory.getLogger(RestApi.class);