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

 


相关文章
|
3天前
|
数据采集 JSON Java
利用Java获取京东SKU接口指南
本文介绍如何使用Java通过京东API获取商品SKU信息。首先,需注册京东开放平台账号并创建应用以获取AppKey和AppSecret。接着,查阅API文档了解调用方法。明确商品ID后,构建请求参数并通过HTTP客户端发送请求。最后,解析返回的JSON数据提取SKU信息。注意遵守API调用频率限制及数据保护法规。此方法适用于电商平台及其他数据获取场景。
|
8天前
|
安全 Java API
java如何请求接口然后终止某个线程
通过本文的介绍,您应该能够理解如何在Java中请求接口并根据返回结果终止某个线程。合理使用标志位或 `interrupt`方法可以确保线程的安全终止,而处理好网络请求中的各种异常情况,可以提高程序的稳定性和可靠性。
38 6
|
26天前
|
Java
java小工具util系列4:基础工具代码(Msg、PageResult、Response、常量、枚举)
java小工具util系列4:基础工具代码(Msg、PageResult、Response、常量、枚举)
48 24
|
7天前
|
前端开发 Java 测试技术
java日常开发中如何写出优雅的好维护的代码
代码可读性太差,实际是给团队后续开发中埋坑,优化在平时,没有那个团队会说我专门给你一个月来优化之前的代码,所以在日常开发中就要多注意可读性问题,不要写出几天之后自己都看不懂的代码。
45 2
|
22天前
|
Java 编译器 数据库
Java 中的注解(Annotations):代码中的 “元数据” 魔法
Java注解是代码中的“元数据”标签,不直接参与业务逻辑,但在编译或运行时提供重要信息。本文介绍了注解的基础语法、内置注解的应用场景,以及如何自定义注解和结合AOP技术实现方法执行日志记录,展示了注解在提升代码质量、简化开发流程和增强程序功能方面的强大作用。
60 5
|
22天前
|
存储 算法 Java
Java 内存管理与优化:掌控堆与栈,雕琢高效代码
Java内存管理与优化是提升程序性能的关键。掌握堆与栈的运作机制,学习如何有效管理内存资源,雕琢出更加高效的代码,是每个Java开发者必备的技能。
48 5
|
24天前
|
Java API 开发者
Java中的Lambda表达式:简洁代码的利器####
本文探讨了Java中Lambda表达式的概念、用途及其在简化代码和提高开发效率方面的显著作用。通过具体实例,展示了Lambda表达式如何在Java 8及更高版本中替代传统的匿名内部类,使代码更加简洁易读。文章还简要介绍了Lambda表达式的语法和常见用法,帮助开发者更好地理解和应用这一强大的工具。 ####
|
25天前
|
Java API
Java中内置的函数式接口
Java中内置的函数式接口
23 2
|
21天前
|
安全 Java API
Java中的Lambda表达式:简化代码的现代魔法
在Java 8的发布中,Lambda表达式的引入无疑是一场编程范式的革命。它不仅让代码变得更加简洁,还使得函数式编程在Java中成为可能。本文将深入探讨Lambda表达式如何改变我们编写和维护Java代码的方式,以及它是如何提升我们编码效率的。
|
26天前
|
Java
Java将OffsetDateTime格式化为 yyyy-MM-dd HH:mm:ss 如何写代码?
Java将OffsetDateTime格式化为 yyyy-MM-dd HH:mm:ss 如何写代码?
29 0