java一行代码实现RESTFul接口

简介: Spring Data REST是构建在Spring Data之上的库,可自动将repository转换为REST服务,支持JPA、MongoDB、Neo4j、GemFire和Cassandra。无需手动创建Service和Controller层。要开始,需配置JPA数据源,创建实体类和Repository接口。快速实现REST接口,只需引入spring-boot-starter-data-rest Maven依赖,并在Repository接口上添加@RepositoryRestResource注解。

一、介绍spring data rest

Spring Data REST是基于Spring Data的repository之上,可以把 repository 自动输出为REST资源,目前支持:

   Spring Data JPA

   Spring Data MongoDB

   Spring Data Neo4j

   Spring Data GemFire

   Spring Data Cassandra

将 Repository 自动转换成REST服务。注意是自动。

三、准备工作

因为Spring Data REST是基于Spring Data的repository之上的,所以我们本节的内容我们选择在《4.6.整合Spring Data JPA操作数据》章节的代码基础上完成。

   配置好JPA数据源

   创建Article实体类

   创建ArticleRepository接口

不需要去创建并手写Service 层和Controller层,将由Spring Data REST帮我们自动完成。

二、实现rest接口的最快方式

通过maven坐标引入Spring Data REST

   <dependency>  

       <groupId>org.springframework.boot</groupId>  

       <artifactId>spring-boot-starter-data-rest</artifactId>  

   </dependency>

在JPA(mogodb等)Repository接口上面加上RepositoryRestResource注解,path是Rest接口资源的基础访问路径。

   @RepositoryRestResource(path="articles")   //就是这一行神奇的代码,甚至这一行都可以不写

   public interface ArticleRepository extends JpaRepository<Article,Long> {

   }

就简单的这样一个实现,Spring Data Rest就可以基于article资源,生成一套GET、PUT、POST、DELETE的增删改查的REST接口,并对外提供服务。如下图:

   注意这个图不是spring-boot-starter-data-rest提供的,下文再说

访问测试,可以通过浏览器或postman,如查询所有:

三、关于接口文档若干问题与建议

   上面的那张图是swagger的图么?答:上面的那张图是集成OpenAPI的图(可以认为是Swagger3.0),非常建议大家使用在线API文档,不然你怎么知道Spring Data Rest帮你生成了哪些API接口,你可以使用哪些接口。

   请注意一个问题:spring-boot-starter-data-rest与swagger2.0并不兼容,所以请参考《2.7.Swagger3-即OpenAPI使用》章节进行在线文档的实现。

   但是OpenAPI默认只能帮我们把手写的代码Controller生成API文档,如果你希望它把spring-boot-starter-data-rest实现的API也展示出来,需要引入

   <dependency>

      <groupId>org.springdoc</groupId>

      <artifactId>springdoc-openapi-data-rest</artifactId>

      <version>1.4.0</version>

   </dependency>

如果你之前的OpenAPI有分组,这里也需要增加一个分组(参考:《2.7.Swagger3-即OpenAPI使用》)

   @Bean

   public GroupedOpenApi articlesApi() {

     return GroupedOpenApi.builder()

             .group("articles")

             .pathsToMatch("/articles/**")

             .build();

   }

四、关键字查询“API接口”

我们还可以依赖JPA的关键字持久层查询接口,实现关键字查询的“API”接口。

   @RepositoryRestResource(path="articles")

   public interface ArticleRepository extends JpaRepository<Article,Long> {

     Article findByAuthor(String author);

   }

接口功能文档如下:通过article表的author参数查询一条记录。

 


相关文章
|
2月前
|
Java 开发工具
【Azure Storage Account】Java Code访问Storage Account File Share的上传和下载代码示例
本文介绍如何使用Java通过azure-storage-file-share SDK实现Azure文件共享的上传下载。包含依赖引入、客户端创建及完整示例代码,助你快速集成Azure File Share功能。
365 5
|
3月前
|
IDE Java 关系型数据库
Java 初学者学习路线(含代码示例)
本教程为Java初学者设计,涵盖基础语法、面向对象、集合、异常处理、文件操作、多线程、JDBC、Servlet及MyBatis等内容,每阶段配核心代码示例,强调动手实践,助你循序渐进掌握Java编程。
450 3
|
3月前
|
安全 Java 应用服务中间件
Spring Boot + Java 21:内存减少 60%,启动速度提高 30% — 零代码
通过调整三个JVM和Spring Boot配置开关,无需重写代码即可显著优化Java应用性能:内存减少60%,启动速度提升30%。适用于所有在JVM上运行API的生产团队,低成本实现高效能。
331 3
|
2月前
|
Java 数据处理 API
为什么你的Java代码应该多用Stream?从循环到声明式的思维转变
为什么你的Java代码应该多用Stream?从循环到声明式的思维转变
259 115
|
2月前
|
安全 Java 编译器
为什么你的Java代码需要泛型?类型安全的艺术
为什么你的Java代码需要泛型?类型安全的艺术
185 98
|
2月前
|
安全 Java 容器
告别繁琐判空:Optional让你的Java代码更优雅
告别繁琐判空:Optional让你的Java代码更优雅
|
2月前
|
安全 Java 容器
告别空指针噩梦:Optional让Java代码更优雅
告别空指针噩梦:Optional让Java代码更优雅
383 94
|
2月前
|
Java 编译器 API
java最新版和java8的区别,用代码展示
java最新版和java8的区别,用代码展示
274 43
|
3月前
|
算法 安全 Java
除了类,Java中的接口和方法也可以使用泛型吗?
除了类,Java中的接口和方法也可以使用泛型吗?
151 11
|
2月前
|
Java Go 开发工具
【Java】(9)抽象类、接口、内部的运用与作用分析,枚举类型的使用
抽象类必须使用abstract修饰符来修饰,抽象方法也必须使用abstract修饰符来修饰,抽象方法不能有方法体。抽象类不能被实例化,无法使用new关键字来调用抽象类的构造器创建抽象类的实例。抽象类可以包含成员变量、方法(普通方法和抽象方法都可以)、构造器、初始化块、内部类(接 口、枚举)5种成分。抽象类的构造器不能用于创建实例,主要是用于被其子类调用。抽象类中不一定包含抽象方法,但是有抽象方法的类必定是抽象类abstract static不能同时修饰一个方法。
218 1