swagger2

SmartCommunity/SmartCommunityV1/eureka-client1/pom.xml

@@ -45,6 +45,18 @@
 			<artifactId>spring-cloud-starter-openfeign</artifactId>
 		</dependency>
 
+		<dependency>
+			<groupId>io.springfox</groupId>
+			<artifactId>springfox-swagger2</artifactId>
+			<version>2.7.0</version>
+		</dependency>
+
+		<dependency>
+			<groupId>io.springfox</groupId>
+			<artifactId>springfox-swagger-ui</artifactId>
+			<version>2.7.0</version>
+		</dependency>
+
 		<dependency>
 			<groupId>org.mybatis.spring.boot</groupId>
 			<artifactId>mybatis-spring-boot-starter</artifactId>

SmartCommunity/SmartCommunityV1/eureka-client1/src/main/java/com/example/demo/Swagger2.java

@@ -0,0 +1,40 @@
+package com.example.demo;
+
+import org.springframework.context.annotation.Bean;
+import org.springframework.context.annotation.Configuration;
+import springfox.documentation.builders.ApiInfoBuilder;
+import springfox.documentation.builders.PathSelectors;
+import springfox.documentation.builders.RequestHandlerSelectors;
+import springfox.documentation.service.ApiInfo;
+import springfox.documentation.service.Contact;
+import springfox.documentation.spi.DocumentationType;
+import springfox.documentation.spring.web.plugins.Docket;
+import springfox.documentation.swagger2.annotations.EnableSwagger2;
+
+/**
+ * @author FXF
+ * @date 2018-09-27
+ */
+@Configuration
+@EnableSwagger2
+public class Swagger2 {
+    @Bean
+    public Docket docket(){
+        return new Docket(DocumentationType.SWAGGER_2).apiInfo(apiInfo()).select()
+                .apis(RequestHandlerSelectors.basePackage("com.example.demo.controller"))
+                .paths(PathSelectors.any()).build();
+    }
+    //构建api文档的详细信息函数
+    private ApiInfo apiInfo(){
+        return new ApiInfoBuilder()
+                //页面标题
+                .title("eureka-client1 的 RESTful API")
+                //创建人
+                .contact(new Contact("fuxingfan","","fuxingfan@dingtalk.com"))
+                //版本号
+                .version("1.0")
+                //描述
+                .description("API 描述")
+                .build();
+    }
+}

SmartCommunity/SmartCommunityV1/eureka-client1/src/main/java/com/example/demo/controller/TestController.java

@@ -4,10 +4,14 @@ import com.example.demo.microController.MicroTestController;
 import com.example.demo.model.ScUser;
 import com.example.demo.service.ScUserServiceI;
 import com.netflix.discovery.DiscoveryClient;
+import io.swagger.annotations.Api;
+import io.swagger.annotations.ApiImplicitParam;
+import io.swagger.annotations.ApiOperation;
 import org.springframework.beans.factory.annotation.Autowired;
 import org.springframework.beans.factory.annotation.Value;
 import org.springframework.cloud.context.config.annotation.RefreshScope;
 import org.springframework.web.bind.annotation.RequestMapping;
+import org.springframework.web.bind.annotation.RequestMethod;
 import org.springframework.web.bind.annotation.ResponseBody;
 import org.springframework.web.bind.annotation.RestController;
 
@@ -20,6 +24,7 @@ import java.util.List;
 @RestController
 @RefreshScope
 @RequestMapping("/client1")
+@Api("eureka-client1的测试controller的API")
 public class TestController {
     
     @Value("${abc}")
@@ -31,7 +36,8 @@ public class TestController {
     @Autowired
     private MicroTestController microTestController;
     
-    @RequestMapping("/hello")
+    @ApiOperation(value = "测试无参", notes = "无参")
+    @RequestMapping(value = "/hello",method = RequestMethod.GET)
     @ResponseBody
     public String index(){
         return abc;
@@ -41,13 +47,14 @@ public class TestController {
      * 获取所有的用户信息
      * @return
      */
-    @RequestMapping("/user")
+    @ApiOperation(value = "测试restful接口", notes = "测试接口")
+    @RequestMapping(value = "/user",method = RequestMethod.GET)
     @ResponseBody
     public List<ScUser> getUser(){
         return scUserService.getUser();
     }
     
-    @RequestMapping("/feignUser")
+    @RequestMapping(value = "/feignUser",method = RequestMethod.GET)
     @ResponseBody
     public List<ScUser> getMicroUser(){
         return microTestController.getUser();

SmartCommunity/SmartCommunityV1/eureka-client2/pom.xml

@@ -39,6 +39,18 @@
 			<artifactId>spring-cloud-starter-openfeign</artifactId>
 		</dependency>
 
+		<dependency>
+			<groupId>io.springfox</groupId>
+			<artifactId>springfox-swagger2</artifactId>
+			<version>2.7.0</version>
+		</dependency>
+
+		<dependency>
+			<groupId>io.springfox</groupId>
+			<artifactId>springfox-swagger-ui</artifactId>
+			<version>2.7.0</version>
+		</dependency>
+
 		<dependency>
 			<groupId>org.springframework.cloud</groupId>
 			<artifactId>spring-cloud-starter-config</artifactId>

SmartCommunity/SmartCommunityV1/eureka-client2/src/main/java/com/example/demo/Swagger2.java

@@ -0,0 +1,40 @@
+package com.example.demo;
+
+import org.springframework.context.annotation.Bean;
+import org.springframework.context.annotation.Configuration;
+import springfox.documentation.builders.ApiInfoBuilder;
+import springfox.documentation.builders.PathSelectors;
+import springfox.documentation.builders.RequestHandlerSelectors;
+import springfox.documentation.service.ApiInfo;
+import springfox.documentation.service.Contact;
+import springfox.documentation.spi.DocumentationType;
+import springfox.documentation.spring.web.plugins.Docket;
+import springfox.documentation.swagger2.annotations.EnableSwagger2;
+
+/**
+ * @author FXF
+ * @date 2018-09-27
+ */
+@Configuration
+@EnableSwagger2
+public class Swagger2 {
+    @Bean
+    public Docket docket(){
+        return new Docket(DocumentationType.SWAGGER_2).apiInfo(apiInfo()).select()
+                .apis(RequestHandlerSelectors.basePackage("com.example.demo.controller"))
+                .paths(PathSelectors.any()).build();
+    }
+    //构建api文档的详细信息函数
+    private ApiInfo apiInfo(){
+        return new ApiInfoBuilder()
+                //页面标题
+                .title("eureka-client2 的 RESTful API")
+                //创建人
+                .contact(new Contact("fuxingfan","","fuxingfan@dingtalk.com"))
+                //版本号
+                .version("1.0")
+                //描述
+                .description("API 描述")
+                .build();
+    }
+}

SmartCommunity/SmartCommunityV1/eureka-client2/src/main/java/com/example/demo/controller/TestController.java

@@ -3,10 +3,13 @@ package com.example.demo.controller;
 import com.example.demo.microController.MicroTestController;
 import com.example.demo.model.ScUser;
 import com.example.demo.service.ScUserServiceI;
+import io.swagger.annotations.Api;
+import io.swagger.annotations.ApiOperation;
 import org.springframework.beans.factory.annotation.Autowired;
 import org.springframework.beans.factory.annotation.Value;
 import org.springframework.cloud.context.config.annotation.RefreshScope;
 import org.springframework.web.bind.annotation.RequestMapping;
+import org.springframework.web.bind.annotation.RequestMethod;
 import org.springframework.web.bind.annotation.ResponseBody;
 import org.springframework.web.bind.annotation.RestController;
 
@@ -19,6 +22,7 @@ import java.util.List;
 @RestController
 @RefreshScope
 @RequestMapping("/client2")
+@Api("eureka-client2的测试controller的API")
 public class TestController {
     
     @Value("${abc}")
@@ -30,7 +34,8 @@ public class TestController {
     @Autowired
     private MicroTestController microTestController;
     
-    @RequestMapping("/hello")
+    @ApiOperation(value = "测试无参", notes = "无参")
+    @RequestMapping(value = "/hello",method = RequestMethod.GET)
     @ResponseBody
     public String index(){
         return abc;
@@ -40,13 +45,14 @@ public class TestController {
      * 获取所有的用户信息
      * @return
      */
-    @RequestMapping("/user")
+    @ApiOperation(value = "测试restful接口", notes = "测试接口2")
+    @RequestMapping(value = "/user",method = RequestMethod.GET)
     @ResponseBody
     public List<ScUser> getUser(){
         return scUserService.getUser();
     }
     
-    @RequestMapping("/feignUser")
+    @RequestMapping(value = "/feignUser",method = RequestMethod.GET)
     @ResponseBody
     public List<ScUser> getMicroUser(){
         return microTestController.getUser();

SmartCommunity/SmartCommunityV1/zuul/pom.xml

@@ -36,6 +36,12 @@
 			<version>1.4.5.RELEASE</version>
 		</dependency>
 
+		<dependency>
+			<groupId>com.didispace</groupId>
+			<artifactId>swagger-butler-core</artifactId>
+			<version>1.0.0</version>
+		</dependency>
+
 		<dependency>
 			<groupId>org.springframework.cloud</groupId>
 			<artifactId>spring-cloud-starter-netflix-eureka-client</artifactId>

SmartCommunity/SmartCommunityV1/zuul/src/main/java/com/example/demo/ZuulApplication.java

@@ -1,5 +1,6 @@
 package com.example.demo;
 
+import com.didispace.swagger.butler.EnableSwaggerButler;
 import org.springframework.boot.SpringApplication;
 import org.springframework.cloud.client.SpringCloudApplication;
 import org.springframework.cloud.client.discovery.EnableDiscoveryClient;
@@ -8,6 +9,7 @@ import org.springframework.cloud.netflix.zuul.EnableZuulProxy;
 @EnableZuulProxy
 @EnableDiscoveryClient
 @SpringCloudApplication
+@EnableSwaggerButler
 public class ZuulApplication {
 
 	public static void main(String[] args) {