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参数查询一条记录。

 


相关文章
|
7天前
|
Java 程序员 API
Java中的Lambda表达式:简化你的代码
【7月更文挑战第10天】Lambda表达式,这一Java 8的闪亮特性,为开发者提供了一种更为简洁、灵活的编程方式。本文将探讨Lambda表达式如何优化代码结构,提升开发效率,以及在实际项目中应用的一些实例。我们将从基础语法入手,逐步深入到高级用法,最后讨论其性能影响,旨在帮助读者全面理解并有效利用Lambda表达式。
32 20
|
3天前
|
数据采集 Java API
java接口防爬虫
7月更文挑战第4天
|
8天前
|
监控 Java Maven
使用AspectJ实现Java代码的运行时织入
使用AspectJ实现Java代码的运行时织入
|
8天前
|
并行计算 Java 大数据
Java中的函数式接口与流式编程
Java中的函数式接口与流式编程
|
1天前
|
SQL Java 数据处理
实时计算 Flink版产品使用问题之使用MavenShadePlugin进行relocation并遇到只包含了Java代码而未包含Scala代码,该怎么办
实时计算Flink版作为一种强大的流处理和批处理统一的计算框架,广泛应用于各种需要实时数据处理和分析的场景。实时计算Flink版通常结合SQL接口、DataStream API、以及与上下游数据源和存储系统的丰富连接器,提供了一套全面的解决方案,以应对各种实时计算需求。其低延迟、高吞吐、容错性强的特点,使其成为众多企业和组织实时数据处理首选的技术平台。以下是实时计算Flink版的一些典型使用合集。
|
6天前
|
Java 编译器 API
Java中的Lambda表达式:简化代码,提升性能
在Java 8中,Lambda表达式的引入为开发者提供了一种更加简洁、灵活的编程方式。本文将深入探讨Lambda表达式的概念、语法、使用场景及其在Java中的应用示例,帮助读者更好地理解和掌握这一强大工具,从而优化代码结构,提高开发效率。
|
7天前
|
Java API
Java面试题:说明Lambda表达式在Java中的应用,以及函数式接口的概念和作用。
Java面试题:说明Lambda表达式在Java中的应用,以及函数式接口的概念和作用。
11 0
|
7天前
|
网络协议 Java
Java面试题:什么是Java中的接口?与抽象类有什么区别?
Java面试题:什么是Java中的接口?与抽象类有什么区别?
9 0
|
9天前
|
缓存 安全 Java
使用Java构建高性能的RESTful服务
使用Java构建高性能的RESTful服务
|
10天前
|
监控 Java Maven
使用AspectJ实现Java代码的运行时织入
使用AspectJ实现Java代码的运行时织入

热门文章

最新文章