swagger

config-client/pom.xml

@@ -35,6 +35,17 @@
 			<artifactId>spring-cloud-starter-config</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.boot</groupId>
 			<artifactId>spring-boot-starter-test</artifactId>

config-client/src/main/java/com/example/demo/Swagger.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-06
+ */
+@Configuration
+@EnableSwagger2
+public class Swagger {
+    @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("springBoot使用Swagger2构建RESTful API")
+                //创建人
+                .contact(new Contact("fuxingfan","","fuxingfan@dingtalk.com"))
+                //版本号
+                .version("1.0")
+                //描述
+                .description("API 描述")
+                .build();
+    }
+}

config-client/src/main/java/com/example/demo/controller/TestController.java

@@ -1,7 +1,12 @@
 package com.example.demo.controller;
 
+import io.swagger.annotations.Api;
+import io.swagger.annotations.ApiImplicitParam;
+import io.swagger.annotations.ApiOperation;
 import org.springframework.beans.factory.annotation.Value;
 import org.springframework.stereotype.Controller;
+import org.springframework.web.bind.annotation.GetMapping;
+import org.springframework.web.bind.annotation.PathVariable;
 import org.springframework.web.bind.annotation.RequestMapping;
 import org.springframework.web.bind.annotation.ResponseBody;
 
@@ -11,15 +16,22 @@ import org.springframework.web.bind.annotation.ResponseBody;
  */
 @Controller
 @RequestMapping("/")
+@Api("测试controller的API")
 public class TestController {
 
-    @Value("${abc}")
-    private String abc;
-
-    @RequestMapping("/test")
+    @ApiOperation(value = "测试无参", notes = "无参")
+    @GetMapping("/test")
     @ResponseBody
     public String test(){
-        System.out.println(abc);
-        return "ok====" + abc;
+        return "ok====";
     }
+
+    @ApiOperation(value = "测试restful接口", notes = "测试接口")
+    @ApiImplicitParam(name = "id", value = "测试ID", paramType = "path", required = true, dataType = "String")
+    @GetMapping("/test/{id}")
+    @ResponseBody
+    public String testSwagger(@PathVariable String id){
+        return id;
+    }
+
 }

config-client/src/main/resources/bootstrap.properties

@@ -1,4 +1,4 @@
-spring.application.name=application
-spring.cloud.config.profile=dev
-spring.cloud.config.label=master
-spring.cloud.config.uri=http://localhost:7001/
+#spring.application.name=application
+#spring.cloud.config.profile=dev
+#spring.cloud.config.label=master
+#spring.cloud.config.uri=http://localhost:7001/