新增swgger

pom.xml

@@ -17,6 +17,20 @@
         <java.version>1.8</java.version>
     </properties>
     <dependencies>
+
+        <dependency>
+            <groupId>io.springfox</groupId>
+            <artifactId>springfox-swagger2</artifactId>
+            <version>2.9.2</version>
+        </dependency>
+
+        <dependency>
+            <groupId>io.springfox</groupId>
+            <artifactId>springfox-swagger-ui</artifactId>
+            <version>2.9.2</version>
+        </dependency>
+
+
         <dependency>
             <groupId>org.springframework.boot</groupId>
             <artifactId>spring-boot-starter-data-jpa</artifactId>

src/main/java/com/example/jpademo/JpaDemoApplication.java

@@ -2,8 +2,12 @@ package com.example.jpademo;
 
 import org.springframework.boot.SpringApplication;
 import org.springframework.boot.autoconfigure.SpringBootApplication;
+import org.springframework.web.servlet.config.annotation.EnableWebMvc;
+import springfox.documentation.swagger2.annotations.EnableSwagger2;
 
 @SpringBootApplication
+@EnableSwagger2
+@EnableWebMvc
 public class JpaDemoApplication {
 
     public static void main(String[] args) {
@@ -11,3 +15,4 @@ public class JpaDemoApplication {
     }
 
 }
+

src/main/java/com/example/jpademo/conf/Swagger2Config.java

+package com.example.jpademo.conf;
+
+import com.google.common.collect.Sets;
+import io.swagger.annotations.Api;
+import org.springframework.context.annotation.Bean;
+import org.springframework.context.annotation.Configuration;
+import org.springframework.web.servlet.config.annotation.*;
+import springfox.documentation.builders.ApiInfoBuilder;
+import springfox.documentation.builders.PathSelectors;
+import springfox.documentation.builders.RequestHandlerSelectors;
+import springfox.documentation.service.ApiInfo;
+import springfox.documentation.spi.DocumentationType;
+import springfox.documentation.spring.web.plugins.Docket;
+import springfox.documentation.swagger2.annotations.EnableSwagger2;
+
+import java.io.File;
+
+/**
+ * fusion-platform.
+ *
+ * @author : Matrix [xhyrzldf@gmail.com]
+ * 19-1-10 .
+ */
+@Configuration
+public class Swagger2Config extends WebMvcConfigurationSupport {
+
+    @Bean
+    public Docket createRestApi() {
+        return new Docket(DocumentationType.SWAGGER_2)
+                .produces(Sets.newHashSet("application/json"))
+                .consumes(Sets.newHashSet("application/json"))
+                .protocols(Sets.newHashSet("http", "https"))
+                .apiInfo(apiInfo())
+                .forCodeGeneration(true)
+                .useDefaultResponseMessages(true)
+                .select()
+                .apis(RequestHandlerSelectors.withClassAnnotation(Api.class))
+                .paths(PathSelectors.any())
+                .build()
+                ;
+    }
+
+    private ApiInfo apiInfo() {
+        return new ApiInfoBuilder()
+                // 文档标题
+                .title("XX系统接口文档")
+                // 文档描述
+                .description("XX系统接口文档与测试页面")
+                .termsOfServiceUrl("http://localhost:8080")
+                .version("v1")
+                .build();
+    }
+
+    /**
+     * 我们使用的 @Configuration 继承了WebMvcConfigurationSupport，导致默认的Swagger静态资源被覆盖，而缺失了配置。
+     * @param registry registry
+     */
+    @Override
+    public void addResourceHandlers(ResourceHandlerRegistry registry) {
+        registry.addResourceHandler("doc.html")
+                .addResourceLocations("classpath:/META-INF/resources/");
+
+        registry.addResourceHandler("swagger-ui.html")
+                .addResourceLocations("classpath:/META-INF/resources/");
+        registry.addResourceHandler("/webjars/**")
+                .addResourceLocations("classpath:/META-INF/resources/webjars/");
+    }
+
+}

src/main/java/com/example/jpademo/controller/StudentController.java

@@ -2,6 +2,9 @@ package com.example.jpademo.controller;
 
 import com.example.jpademo.pojo.Student;
 import com.example.jpademo.service.StudentService;
+import io.swagger.annotations.Api;
+import io.swagger.annotations.ApiOperation;
+import io.swagger.annotations.ApiParam;
 import org.springframework.beans.factory.annotation.Autowired;
 import org.springframework.http.ResponseEntity;
 import org.springframework.web.bind.annotation.*;
@@ -14,16 +17,19 @@ import java.util.List;
  */
 @RestController
 @RequestMapping("/model")
+@Api(tags = "学生模块", description = "学生模块的接口信息")
 public class StudentController {
 
     @Autowired
     private StudentService studentService;
 
     @GetMapping("/student")
-    public ResponseEntity<Student> findOne(@RequestParam Integer id) {
+    @ApiOperation(value = "根据学生id查找学生的接口")
+    public ResponseEntity<Student> findOne(@RequestParam @ApiParam(value = "学生id", example = "10") Integer id) {
         return ResponseEntity.ok(studentService.findById(id));
     }
 
+    @ApiOperation(value = "保存学生的接口")
     @PostMapping("/student")
     public Student saveOne(@RequestBody Student student) {
         return studentService.saveOne(student);

src/main/java/com/example/jpademo/pojo/Student.java

 package com.example.jpademo.pojo;
 
+import io.swagger.annotations.ApiModel;
+import io.swagger.annotations.ApiModelProperty;
 import lombok.AllArgsConstructor;
 import lombok.Data;
 import lombok.NoArgsConstructor;
@@ -14,16 +16,21 @@ import javax.persistence.*;
 @AllArgsConstructor
 @NoArgsConstructor
 @Entity
+@ApiModel("人员信息")
 public class Student {
 
     @Id
     @GeneratedValue(strategy = GenerationType.IDENTITY)
+    @ApiModelProperty(value = "主键id", example = "1")
     private Integer id;
 
+    @ApiModelProperty(value = "姓名", example = "张三")
     private String name;
 
+    @ApiModelProperty(value = "年龄", example = "15")
     private Integer age;
 
+    @ApiModelProperty(value = "外键", example = "1")
     private Integer unionId;
 
     @Transient

src/main/resources/application.properties

-server.port=8079
+server.port=8078
 
 
 # mysql jdbc