Spring Data REST

bapinggaitianli

2020-04-07

1.REST（Representational State Transfer）

用来规范应用如何在 HTTP 层与 API 提供方进行数据交互

REST约束

1.客户端-服务器结构
2.无状态
3.可缓存
4.分层的系统
5.按需代码（可选）
6.统一接口。　　该约束是 REST 服务的基础，是客户端和服务器之间的桥梁。该约束又包含下面4个子约束:
　　　　资源标识符。每个资源都有各自的标识符。客户端在请求时需要指定该标识符。在 REST 服务中，该标识符通常是 URI。客户端所获取的是资源的表达（representation），通常使用 XML 或 JSON 格式。
　　　　通过资源的表达来操纵资源。客户端根据所得到的资源的表达中包含的信息来了解如何操纵资源，比如对资源进行修改或删除。
　　　　自描述的消息。每条消息都包含足够的信息来描述如何处理该消息。
　　　　超媒体作为应用状态的引擎（HATEOAS）。客户端通过服务器提供的超媒体内容中动态提供的动作来进行状态转换。

2.HATEOAS(The Hypermedia As The Engine Of Application Statue)

是REST架构的主要约束

REST成熟的模型

第一个层次（Level 0）的 Web 服务只是使用 HTTP 作为传输方式，实际上只是远程方法调用（RPC）的一种具体形式。SOAP 和 XML-RPC 都属于此类。
第二个层次（Level 1）的 Web 服务引入了资源的概念。每个资源有对应的标识符和表达。
第三个层次（Level 2）的 Web 服务使用不同的 HTTP 方法来进行不同的操作，并且使用 HTTP 状态码来表示不同的结果。如 HTTP GET 方法来获取资源，HTTP DELETE 方法来删除资源。
第四个层次（Level 3）的 Web 服务使用 HATEOAS。在资源的表达中包含了链接信息。客户端可以根据链接来发现可以执行的动作。

根据REST 成熟度模型中可以看到，使用 HATEOAS 的 REST 服务是成熟度最高的，也是推荐的做法

RESTful API最好做到Hypermedia,或HATEOAS，即返回结果中提供链接，连向其他API方法，使得用户不查文档，也知道下一步应该做什么

eg：

{ 
    "links": { 
     "self": { "href": "http://api.com/items" }, 
     "item": [ 
      { "href": "http://api.com/items/1" }, 
      { "href": "http://api.com/items/2" } 
     ] 
    "data": [ 
      {"itemName":"a"}, 
      {"itemName":"b"} 
    ] 
}

3.HAL（Hypertext Application Language）

HAL是一种简单的格式，为 API 中的资源提供简单一致的链接

HAL可以用来实现HATEOAS

HAL 模型包括：

链接

内嵌资源

状态

Spring Data REST

HAL专为构建API而设计，在这些API中，客户端通过以下链接在客户端中浏览资源

4.spring-boot-starter-data-rest使用Spring Boot构建RESTful API

Spring Data REST是基于Spring Data的repository之上，可以把 repository 自动输出为REST资源

Spring Data REST把我们需要编写的大量REST模版接口做了自动化实现，并符合HAL的规范
（1）添加依赖

<dependency>
     <groupId>org.springframework.boot</groupId>
     <artifactId>spring-boot-starter-data-rest</artifactId>
</dependency>

（2）示例

实体类User

package com.example.demo.model;

import lombok.*;
import org.hibernate.annotations.CreationTimestamp;

import javax.persistence.*;
import java.util.Date;

@Entity
@Table(name = "users")
@Data
@Builder
@ToString(callSuper = true)
@NoArgsConstructor
@AllArgsConstructor
public class Users {
    @Id
    @GeneratedValue(strategy = GenerationType.AUTO)
    private int id;
    private String name;
    @Column(updatable = false)
    @CreationTimestamp
    private Date createTime;
}

UsersRepository

package com.example.demo.repository;

import com.example.demo.model.Users;
import org.springframework.data.jpa.repository.JpaRepository;
import org.springframework.stereotype.Repository;

import java.util.List;

@Repository
public interface UsersRepository extends JpaRepository<Users,Integer> {
}

这样就已经提供了一个关于user的rest api，简单的增、删、改、查都有了。不用写Controller，spring已经实现了

启动项目

GET http://127.0.0.1:8080

{
  "_links": {
    "userses": {
      "href": "http://127.0.0.1:8080/userses{?page,size,sort}",
      "templated": true
    },
    "profile": {
      "href": "http://127.0.0.1:8080/profile"
    }
  }
}

分页+排序查询

GET http://127.0.0.1:8080/userses?page=1&size=2&sort=createTime

{
  "_embedded": {
    "userses": [
      {
        "name": "Nana",
        "createTime": "2020-04-07T02:10:12.469+0000",
        "_links": {
          "self": {
            "href": "http://127.0.0.1:8080/userses/5"
          },
          "users": {
            "href": "http://127.0.0.1:8080/userses/5"
          }
        }
      },
      {
        "name": "xyz",
        "createTime": "2020-04-07T02:10:12.469+0000",
        "_links": {
          "self": {
            "href": "http://127.0.0.1:8080/userses/3"
          },
          "users": {
            "href": "http://127.0.0.1:8080/userses/3"
          }
        }
      }
    ]
  },
  "_links": {
    "first": {
      "href": "http://127.0.0.1:8080/userses?page=0&size=2&sort=createTime,asc"
    },
    "prev": {
      "href": "http://127.0.0.1:8080/userses?page=0&size=2&sort=createTime,asc"
    },
    "self": {
      "href": "http://127.0.0.1:8080/userses"
    },
    "next": {
      "href": "http://127.0.0.1:8080/userses?page=2&size=2&sort=createTime,asc"
    },
    "last": {
      "href": "http://127.0.0.1:8080/userses?page=2&size=2&sort=createTime,asc"
    },
    "profile": {
      "href": "http://127.0.0.1:8080/profile/userses"
    }
  },
  "page": {
    "size": 2,
    "totalElements": 5,
    "totalPages": 3,
    "number": 1
  }
}

查询某一个

GET http://127.0.0.1:8080/userses/5

{
  "name": "Nana",
  "createTime": "2020-04-07T02:10:12.469+0000",
  "_links": {
    "self": {
      "href": "http://127.0.0.1:8080/userses/5"
    },
    "users": {
      "href": "http://127.0.0.1:8080/userses/5"
    }
  }
}

新增

POST http://127.0.0.1:8080/userses

Spring Data REST

修改

PUT http://127.0.0.1:8080/userses/481

Spring Data REST

删除

DELETE http://127.0.0.1:8080/userses/481

（3）其他

注解 @RepositoryRestResource指定切入点

eg：

映射到 /user上

添加自定义查询

　　findByName

　　findByNameContaining

package com.example.demo.repository;

import com.example.demo.model.Users;
import org.springframework.data.jpa.repository.JpaRepository;
import org.springframework.data.repository.query.Param;
import org.springframework.data.rest.core.annotation.RepositoryRestResource;
import org.springframework.stereotype.Repository;

import java.util.List;

@RepositoryRestResource(collectionResourceRel = "user", path = "user")
public interface UsersRepository extends JpaRepository<Users,Integer> {
    List<Users> findByName(@Param("name") String name);
    List<Users> findByNameContaining(@Param("name") String name);
}

注：

方法的定义，参数要有 @Param 注解

重新启动项目

GET http://127.0.0.1:8080/user

{
  "_embedded": {
    "user": [
      {
        "name": "Lili",
        "createTime": "2020-04-07T02:50:27.501+0000",
        "_links": {
          "self": {
            "href": "http://127.0.0.1:8080/user/1"
          },
          "users": {
            "href": "http://127.0.0.1:8080/user/1"
          }
        }
      },
      {
        "name": "Fiona",
        "createTime": "2020-04-07T02:50:27.508+0000",
        "_links": {
          "self": {
            "href": "http://127.0.0.1:8080/user/2"
          },
          "users": {
            "href": "http://127.0.0.1:8080/user/2"
          }
        }
      },
      {
        "name": "xyz",
        "createTime": "2020-04-07T02:50:27.508+0000",
        "_links": {
          "self": {
            "href": "http://127.0.0.1:8080/user/3"
          },
          "users": {
            "href": "http://127.0.0.1:8080/user/3"
          }
        }
      }
      }
    ]
  },
  "_links": {
    "self": {
      "href": "http://127.0.0.1:8080/user{?page,size,sort}",
      "templated": true
    },
    "profile": {
      "href": "http://127.0.0.1:8080/profile/user"
    },
    "search": {
      "href": "http://127.0.0.1:8080/user/search"
    }
  },
  "page": {
    "size": 20,
    "totalElements": 5,
    "totalPages": 1,
    "number": 0
  }
}

GET http://127.0.0.1:8080/user/search

{
  "_links": {
    "findByNameContaining": {
      "href": "http://127.0.0.1:8080/user/search/findByNameContaining{?name}",
      "templated": true
    },
    "findByName": {
      "href": "http://127.0.0.1:8080/user/search/findByName{?name}",
      "templated": true
    },
    "self": {
      "href": "http://127.0.0.1:8080/user/search"
    }
  }
}

查询 name=xyz

GET http://127.0.0.1:8080/user/search/findByName?name=xyz

{
  "_embedded": {
    "user": [
      {
        "name": "xyz",
        "createTime": "2020-04-07T03:14:11.921+0000",
        "_links": {
          "self": {
            "href": "http://127.0.0.1:8080/user/3"
          },
          "users": {
            "href": "http://127.0.0.1:8080/user/3"
          }
        }
      }
    ]
  },
  "_links": {
    "self": {
      "href": "http://127.0.0.1:8080/user/search/findByName?name=xyz"
    }
  }
}

查询 name 包含i的

GET http://127.0.0.1:8080/user/search/findByNameContaining?name=i

{
  "_embedded": {
    "user": [
      {
        "name": "Lili",
        "createTime": "2020-04-07T03:14:11.913+0000",
        "_links": {
          "self": {
            "href": "http://127.0.0.1:8080/user/1"
          },
          "users": {
            "href": "http://127.0.0.1:8080/user/1"
          }
        }
      },
      {
        "name": "Fiona",
        "createTime": "2020-04-07T03:14:11.920+0000",
        "_links": {
          "self": {
            "href": "http://127.0.0.1:8080/user/2"
          },
          "users": {
            "href": "http://127.0.0.1:8080/user/2"
          }
        }
      }
    ]
  },
  "_links": {
    "self": {
      "href": "http://127.0.0.1:8080/user/search/findByNameContaining?name=i"
    }
  }
}

配置

在application.properties 中配置

给所有的接口添加统一的前缀

spring.data.rest.base-path=/rest

添加/更新成功时是否返回添加/更新记录

spring.data.rest.return-body-on-create=true
spring.data.rest.return-body-on-update=true

注：

如果为false，则返回空白

rest data api

bapinggaitianli

0 关注 0 粉丝 0 动态

关注关注

5招助您设计出更好的REST API

毋庸置疑，API已成为了当前在不同系统之间交换信息的实际标准。在本文中，我将和您讨论在进行多种REST API设计和实现时，那些值得遵循的良好实践原则。此外，由于这些SDK由提供商所维护，因此开发人员无需进行繁琐的测试、修复和更改，即可支持各种新的API节

futurechallenger 2020-07-10

如何用Spring WebFlux构建Reactive REST API

在本文中，我们将讨论如何使用Spring WebFlux来构建响应式REST API。在正式讨论之前，让我们首先来看看系统的开发，传统REST在实现中遇到的问题，以及当前API的普遍需求。如今的系统讲求的是：分布式应用、云原生、高可用性和可扩展性。因此，

liuqipao 2020-07-07

REST是什么？RESTFul又是什么？这二者的关系是怎样的？

是一种针对网络应用的设计和开发方式，可以降低开发的复杂性，提高系统的可伸缩性。客户端和服务器之间的交互在请求之间是无状态的。从客户端到服务器的每个请求都必须包含理解请求所必需的信息。如果服务器在请求之间的任何时间点重启，客户端不会得到通知。无状态请求可以由

ahnjwj 2020-07-28

Django快速开发实践：Drf框架和xadmin配置指北

经过这些步骤就能得到一个具备完整的后端接口和后台管理界面的网站了，如果写了template的话还能把前端的工作也做了。接下来按照上面提到的顺序记录一下我的开发实践。好像没啥好说的，Django3多了几个新的特性，可以用class来定义choices，这个比

iflreey 2020-07-04

Django REST framework基础：视图和路由

在Django REST Framework中内置的Request类扩展了Django中的Request类，实现了很多方便的功能--如请求数据解析和认证等。比如，区别于Django中的request从request.GET中获取URL参数，从request

tuxlcsdn 2020-06-21

REST与RESTful学习

2000年，由Roy Thomas Fielding在他的博士论文中提出。REST定义了一种互联网软件的架构原则。因此，REST也可以说是一种架构风格。REST式的web服务是一种ROA，资源是核心。上网的过程就是调用资源的URI，来获取资源不同表现形式的

84560296 2020-06-09

Django REST framework JWT

　　Json web token , 是为了在网络应用环境间传递声明而执行的一种基于JSON的开放标准. 该token被设计为紧凑且安全的，特别适用于分布式站点的单点登录场景。JWT的声明一般被用来在身份提供者和服务提供者间传递被认证的用户身份信息，以便于

Burgesszheng 2020-06-07

REST Framework接口规范

网络应用程序，分为前端和后端两个部分。当前的发展趋势，就是前端设备层出不穷（手机、平板、桌面电脑、其他专用设备…因此，必须有一种统一的机制，方便不同的前端设备与后端进行通信。这导致API构架的流行，甚至出现APIFirst的设计思想。RESTful API

TimeMagician 2020-05-27

【docker Elasticsearch】Rest风格的分布式开源搜索和分析引擎Elasticsearch初体验

Elasticsearch 是一个分布式、可扩展、实时的搜索与数据分析引擎。它能从项目一开始就赋予你的数据以搜索、分析和探索的能力，这是通常没有预料到的。它存在还因为原始数据如果只是躺在磁盘里面根本就毫无用处。Elasticsearch 不仅仅只是全文搜索

蜡笔小鑫爱看雪 2020-03-27

Ajax,restful/Rest JSON和JSONP

Ajax– “异步Javascript和XML”。Ajax宽松地定义了一组技术，以帮助使Web应用程序提供更丰富的用户体验。屏幕的数据更新和刷新是使用javascript和xml异步完成。以JSON表示的对象可以转换为要在javascript代码中操作的实

Richardxx 2020-03-07

Spring Boot Rest控制器单元测试

Spring Boot提供了一种为Rest Controller文件编写单元测试的简便方法。单元测试应该写在src/test/java目录下，用于编写测试的类路径资源应该放在src/test/resources目录下。对于编写单元测试，需要在构建配置文件中

84224552 2020-03-06

0010 Django工程配置（07 REST_FRAMEWORK配置）

　　DRF有丰富的功能，JWT认证、过滤、分页、异常处理、接口文档、限流、缓存等。　　这些配置，有些需要写自定义接口，有些只需要配置就可以了。# 也可通过自定义Pagination类，来为视图添加不同分页行为。在视图中通过pagination_clas属性

时光如瑾雨微凉 2020-03-04

Uni-app基础实战富文本框解析 WordPress rest api实例（二）

官方的富文本框有markdown和html两种方式，但是样式欠佳！官网可以一键导入，直接点击hbuilder x导入就ojbk。另外新建界面和界面配置这边不说啦，如果有需要可以看上面文章或者之前更早的文章。在用浏览器运行应该就可以看到我是html代码这

zcl 2020-03-04

Springboot使用RestHighLevelClient7操作es

Elasticsearch Java Rest Client 上手指南（上）。Elasticsearch的几种Java客户端。elasticsearch 的两种连接方式+三种客户端。Elasticsearch系列(七)----JAVA客户端之RestCli

tigercn 2020-02-23

django中时间区间过滤

filter_fields = #指向要过滤的类

Yort 2020-02-22

Django Rest Framework 频率组件

# 定义频率类并继承SimpleRateThrottle. rate = ‘5/m‘ # 指定访问频率，5/m表示每分钟5次。局部使用===》在views.py需要使用频率的视图函数中注册频率类。# 在需要权限的数据接口里面指定权限类。全局使用==

明瞳 2020-02-22

Django Rest Framework 认证组件

‘‘‘用户认证章节‘‘‘。# 定义返回消息体。response["status_message"] = "登录失败，用户名或密码错误". # 在需要认证的数据接口里面指定认证类。#创建随机字符串用作token

tuxlcsdn 2020-02-21

DRF（Django Rest Framework）序列化组件接口使用和接口设计--!GET接口设计!

定义序列化器，一般包括模型类的字段，有自己的字段类型规则。实现了序列化器后，就可以创建序列化对象以及查询集进行序列化操作，通过序列化对象.data来获取数据。#创建一个方法必须：get_字段名，并传入一个对象。

明瞳 2020-02-17

Django REST Framework JWT

################### 2、配置jwt验证 ######################. AUTH_USER_MODEL=‘users.User‘ # 指定使用users APP中的 model setting.py. path, #

GreatZhou 2020-02-11

rest framework-restful介绍-长期维护

# 为什么学习这个rest framework？# 1，写代码的时候会用到，前后端分离的项目，可以帮助我们快速的写api，# 2，面试的时候会问到，# 这个框架提供了一些什么功能？# 1，权限组件，# 3，访问频率限制组件，把字符串序列化为json返回，#

beibeijia 2020-02-11

安科网

Spring Data REST

bapinggaitianli

bapinggaitianli

相关推荐

5招助您设计出更好的REST API

如何用Spring WebFlux构建Reactive REST API

REST是什么？RESTFul又是什么？这二者的关系是怎样的？

Django快速开发实践：Drf框架和xadmin配置指北

Django REST framework基础：视图和路由

REST与RESTful学习

Django REST framework JWT

REST Framework接口规范

【docker Elasticsearch】Rest风格的分布式开源搜索和分析引擎Elasticsearch初体验

Ajax,restful/Rest JSON和JSONP

Spring Boot Rest控制器单元测试

0010 Django工程配置（07 REST_FRAMEWORK配置）

Uni-app基础实战富文本框解析 WordPress rest api实例（二）

Springboot使用RestHighLevelClient7操作es

django中时间区间过滤

Django Rest Framework 频率组件

Django Rest Framework 认证组件

DRF（Django Rest Framework）序列化组件接口使用和接口设计--!GET接口设计!

Django REST Framework JWT

rest framework-restful介绍-长期维护

bapinggaitianli