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

 


相关文章
|
5天前
|
Java
在 Java 中捕获和处理自定义异常的代码示例
本文提供了一个 Java 代码示例,展示了如何捕获和处理自定义异常。通过创建自定义异常类并使用 try-catch 语句,可以更灵活地处理程序中的错误情况。
|
8天前
|
JSON Java Apache
非常实用的Http应用框架,杜绝Java Http 接口对接繁琐编程
UniHttp 是一个声明式的 HTTP 接口对接框架,帮助开发者快速对接第三方 HTTP 接口。通过 @HttpApi 注解定义接口,使用 @GetHttpInterface 和 @PostHttpInterface 等注解配置请求方法和参数。支持自定义代理逻辑、全局请求参数、错误处理和连接池配置,提高代码的内聚性和可读性。
|
20天前
|
XML 安全 Java
Java反射机制:解锁代码的无限可能
Java 反射(Reflection)是Java 的特征之一,它允许程序在运行时动态地访问和操作类的信息,包括类的属性、方法和构造函数。 反射机制能够使程序具备更大的灵活性和扩展性
33 5
Java反射机制:解锁代码的无限可能
|
9天前
|
Java
java线程接口
Thread的构造方法创建对象的时候传入了Runnable接口的对象 ,Runnable接口对象重写run方法相当于指定线程任务,创建线程的时候绑定了该线程对象要干的任务。 Runnable的对象称之为:线程任务对象 不是线程对象 必须要交给Thread线程对象。 通过Thread的构造方法, 就可以把任务对象Runnable,绑定到Thread对象中, 将来执行start方法,就会自动执行Runable实现类对象中的run里面的内容。
23 1
|
14天前
|
Java 开发者
在Java多线程编程的世界里,Lock接口正逐渐成为高手们的首选,取代了传统的synchronized关键字
在Java多线程编程的世界里,Lock接口正逐渐成为高手们的首选,取代了传统的synchronized关键字
41 4
|
16天前
|
jenkins Java 测试技术
如何使用 Jenkins 自动发布 Java 代码,通过一个电商公司后端服务的实际案例详细说明
本文介绍了如何使用 Jenkins 自动发布 Java 代码,通过一个电商公司后端服务的实际案例,详细说明了从 Jenkins 安装配置到自动构建、测试和部署的全流程。文中还提供了一个 Jenkinsfile 示例,并分享了实践经验,强调了版本控制、自动化测试等关键点的重要性。
48 3
|
17天前
|
分布式计算 Java MaxCompute
ODPS MR节点跑graph连通分量计算代码报错java heap space如何解决
任务启动命令:jar -resources odps-graph-connect-family-2.0-SNAPSHOT.jar -classpath ./odps-graph-connect-family-2.0-SNAPSHOT.jar ConnectFamily 若是设置参数该如何设置
|
15天前
|
Java
Java代码解释++i和i++的五个主要区别
本文介绍了前缀递增(++i)和后缀递增(i++)的区别。两者在独立语句中无差异,但在赋值表达式中,i++ 返回原值,++i 返回新值;在复杂表达式中计算顺序不同;在循环中虽结果相同但使用方式有别。最后通过 `Counter` 类模拟了两者的内部实现原理。
Java代码解释++i和i++的五个主要区别
|
19天前
|
Java
Java基础(13)抽象类、接口
本文介绍了Java面向对象编程中的抽象类和接口两个核心概念。抽象类不能被实例化,通常用于定义子类的通用方法和属性;接口则是完全抽象的类,允许声明一组方法但不实现它们。文章通过代码示例详细解析了抽象类和接口的定义及实现,并讨论了它们的区别和使用场景。
|
19天前
|
Java 测试技术 API
Java零基础-接口详解
【10月更文挑战第19天】Java零基础教学篇,手把手实践教学!
18 1