spring Data jpa整合 swgger 和vue（swgger）

最新推荐文章于 2022-12-03 13:01:00 发布

cxxx45

最新推荐文章于 2022-12-03 13:01:00 发布

阅读量193

点赞数

本文链接：https://blog.youkuaiyun.com/cxxx45/article/details/90812449

版权

本文介绍了如何将Spring Data JPA与Swagger整合，同时提到了Vue的使用。详细步骤包括添加Swagger依赖，配置JPA设置，创建SwaggerConfig类，启用Swagger2注解，并在启动类和控制器中应用。此外，还涉及到WebConfig类中的跨域配置。

摘要生成于 C知道，由 DeepSeek-R1 满血版支持，前往体验 >

swgger依赖

  <dependency>
            <groupId>io.springfox</groupId>
            <artifactId>springfox-swagger2</artifactId>
            <version>2.6.1</version>
        </dependency>
        <dependency>
            <groupId>io.springfox</groupId>
            <artifactId>springfox-swagger-ui</artifactId>
            <version>2.6.1</version>
        </dependency>

yml的Jpa配置

server:
    port: 8080

spring:
  datasource:
    driver-class-name: com.mysql.cj.jdbc.Driver
    url: jdbc:mysql://localhost:3306/jpa?useUnicode=true&characterEncoding=UTF-8&serverTimezone=UTC
    username: root
    password: root

  jpa:
    show-sql: true  #显示sql语句
    hibernate:
      ddl-auto: update
      naming:
        implicit-strategy: org.hibernate.boot.model.naming.ImplicitNamingStrategyComponentPathImpl
        physical-strategy: org.hibernate.boot.model.naming.PhysicalNamingStrategyStandardImpl
    database: mysql #配置现在所使用的数据库

SwaggerConfig类

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.spi.DocumentationType;
import springfox.documentation.spring.web.plugins.Docket;
import springfox.documentation.swagger2.annotations.EnableSwagger2;

@Configuration
@EnableSwagger2
public class SwaggerConfig {
    @Bean
    public Docket createRestApi() {
        return new Docket(DocumentationType.SWAGGER_2)
                .apiInfo(apiInfo())
                .select()
                .apis(RequestHandlerSelectors.basePackage("com.cx.swggervue.controller"))
                .paths(PathSelectors.any())
                .build();
    }

    private ApiInfo apiInfo() {
        return new ApiInfoBuilder()
                .title("Spring Boot中使用Swagger2实现前后端分离开发")
                .description("此项目只是练习如何实现前后端分离开发的小Demo")
                .termsOfServiceUrl("https://blog.youkuaiyun.com/cxxx45")
                .contact("作者名")
                .version("1.0")
                .build();
    }
}

启动类打@EnableSwagger2注解

package com.cx.swggervue;

import org.springframework.boot.SpringApplication;
import org.springframework.boot.autoconfigure.SpringBootApplication;
import springfox.documentation.swagger2.annotations.EnableSwagger2;

@SpringBootApplication
@EnableSwagger2
public class SwggerVueApplication {

    public static void main(String[] args) {
        SpringApplication.run(SwggerVueApplication.class, args);
    }

}

StudentController类添加@EnableSwagger2

package com.cx.swggervue.controller;

import com.cx.swggervue.entity.Student;
import com.cx.swggervue.service.impl.StudentServiceImpl;
import org.springframework.beans.factory.annotation.Autowired;
import org.springframework.data.domain.Page;
import org.springframework.web.bind.annotation.*;
import springfox.documentation.swagger2.annotations.EnableSwagger2;

@RestController
@EnableSwagger2
public class StudentController {

    @Autowired
    private StudentServiceImpl studentService;

    @PostMapping("/findAll")
    public Page<Student> findAll(Integer page,String name){
        return studentService.findAll(page,null,name);
    }
	@ApiOperation(value="删除学生", notes="根据url的id来指定删除用户")
    @ApiImplicitParam(name = "id", value = "用户ID", required = true, dataType = "Long", paramType = "path")
    @DeleteMapping("/del")
    public void del(Long id){
        studentService.del(id);
    }

    @PostMapping("/save")
    public Student save(@RequestBody Student student){
        return  studentService.save(student);
    }

}

WebConfig类实现跨域

package com.cx.swggervue;

import org.springframework.context.annotation.Bean;
import org.springframework.context.annotation.Configuration;
import org.springframework.web.servlet.config.annotation.CorsRegistry;
import org.springframework.web.servlet.config.annotation.WebMvcConfigurer;

@Configuration
public class WebConfig implements WebMvcConfigurer {

    //跨域配置
    @Bean
    public WebMvcConfigurer corsConfigurer() {
        return new WebMvcConfigurer() {
            @Override
            //重写父类提供的跨域请求处理的接口
            public void addCorsMappings(CorsRegistry registry) {
                //添加映射路径
                registry.addMapping("/**")
                        //放行哪些原始域
                        .allowedOrigins("*")
                        //是否发送Cookie信息
                        .allowCredentials(true)
                        //放行哪些原始域(请求方式)
                        .allowedMethods("GET", "POST", "PUT", "DELETE")
                        //放行哪些原始域(头部信息)
                        .allowedHeaders("*")
                        //暴露哪些头部信息（因为跨域访问默认不能获取全部头部信息）
                        .exposedHeaders("Header1", "Header2");
            }
        };
    }
}