Restful架构2

最新推荐文章于 2021-12-04 00:59:16 发布
最新推荐文章于 2021-12-04 00:59:16 发布
阅读量383 收藏
点赞数
分类专栏： web后台

网络应用程序，分为前端和后端两个部分。当前的发展趋势，就是前端设备层出不穷（手机、平板、桌面电脑、其他专用设备......）。

因此，必须有一种统一的机制，方便不同的前端设备与后端进行通信。这导致API构架的流行，甚至出现"API First"的设计思想。RESTful API是目前比较成熟的一套互联网应用程序的API设计理论。我以前写过一篇《理解RESTful架构》，探讨如何理解这个概念。

今天，我将介绍RESTful API的设计细节，探讨如何设计一套合理、好用的API。我的主要参考了两篇文章（1，2）。

RESTful API

一、协议

API与用户的通信协议，总是使用HTTPs协议。

二、域名

应该尽量将API部署在专用域名之下。


https://api.example.com

如果确定API很简单，不会有进一步扩展，可以考虑放在主域名下。


https://example.org/api/

三、版本（Versioning）

应该将API的版本号放入URL。


https://api.example.com/v1/

另一种做法是，将版本号放在HTTP头信息中，但不如放入URL方便和直观。Github采用这种做法。

四、路径（Endpoint）

路径又称"终点"（endpoint），表示API的具体网址。

在RESTful架构中，每个网址代表一种资源（resource），所以网址中不能有动词，只能有名词，而且所用的名词往往与数据库的表格名对应。一般来说，数据库中的表都是同种记录的"集合"（collection），所以API中的名词也应该使用复数。

举例来说，有一个API提供动物园（zoo）的信息，还包括各种动物和雇员的信息，则它的路径应该设计成下面这样。

  • https://api.example.com/v1/zoos
  • https://api.example.com/v1/animals
  • https://api.example.com/v1/employees

五、HTTP动词

对于资源的具体操作类型，由HTTP动词表示。

常用的HTTP动词有下面五个（括号里是对应的SQL命令）。

  • GET（SELECT）：从服务器取出资源（一项或多项）。
  • POST（CREATE）：在服务器新建一个资源。
  • PUT（UPDATE）：在服务器更新资源（客户端提供改变后的完整资源）。
  • PATCH（UPDATE）：在服务器更新资源（客户端提供改变的属性）。
  • DELETE（DELETE）：从服务器删除资源。

还有两个不常用的HTTP动词。

  • HEAD：获取资源的元数据。
  • OPTIONS：获取信息，关于资源的哪些属性是客户端可以改变的。

下面是一些例子。

  • GET /zoos：列出所有动物园
  • POST /zoos：新建一个动物园
  • GET /zoos/ID：获取某个指定动物园的信息
  • PUT /zoos/ID：更新某个指定动物园的信息（提供该动物园的全部信息）
  • PATCH /zoos/ID：更新某个指定动物园的信息（提供该动物园的部分信息）
  • DELETE /zoos/ID：删除某个动物园
  • GET /zoos/ID/animals：列出某个指定动物园的所有动物
  • DELETE /zoos/ID/animals/ID：删除某个指定动物园的指定动物

六、过滤信息（Filtering）

如果记录数量很多，服务器不可能都将它们返回给用户。API应该提供参数，过滤返回结果。

下面是一些常见的参数。

  • ?limit=10：指定返回记录的数量
  • ?offset=10：指定返回记录的开始位置。
  • ?page=2&per_page=100：指定第几页，以及每页的记录数。
  • ?sortby=name&order=asc：指定返回结果按照哪个属性排序，以及排序顺序。
  • ?animal_type_id=1：指定筛选条件

参数的设计允许存在冗余，即允许API路径和URL参数偶尔有重复。比如，GET /zoo/ID/animals 与 GET /animals?zoo_id=ID 的含义是相同的。

七、状态码（Status Codes）

服务器向用户返回的状态码和提示信息，常见的有以下一些（方括号中是该状态码对应的HTTP动词）。

  • 200 OK - [GET]：服务器成功返回用户请求的数据，该操作是幂等的（Idempotent）。
  • 201 CREATED - [POST/PUT/PATCH]：用户新建或修改数据成功。
  • 202 Accepted - [*]：表示一个请求已经进入后台排队（异步任务）
  • 204 NO CONTENT - [DELETE]：用户删除数据成功。
  • 400 INVALID REQUEST - [POST/PUT/PATCH]：用户发出的请求有错误，服务器没有进行新建或修改数据的操作，该操作是幂等的。
  • 401 Unauthorized - [*]：表示用户没有权限（令牌、用户名、密码错误）。
  • 403 Forbidden - [*] 表示用户得到授权（与401错误相对），但是访问是被禁止的。
  • 404 NOT FOUND - [*]：用户发出的请求针对的是不存在的记录，服务器没有进行操作，该操作是幂等的。
  • 406 Not Acceptable - [GET]：用户请求的格式不可得（比如用户请求JSON格式，但是只有XML格式）。
  • 410 Gone -[GET]：用户请求的资源被永久删除，且不会再得到的。
  • 422 Unprocesable entity - [POST/PUT/PATCH] 当创建一个对象时，发生一个验证错误。
  • 500 INTERNAL SERVER ERROR - [*]：服务器发生错误，用户将无法判断发出的请求是否成功。

状态码的完全列表参见这里。

八、错误处理（Error handling）

如果状态码是4xx，就应该向用户返回出错信息。一般来说，返回的信息中将error作为键名，出错信息作为键值即可。


{
    error: "Invalid API key"
}

九、返回结果

针对不同操作，服务器向用户返回的结果应该符合以下规范。

  • GET /collection：返回资源对象的列表（数组）
  • GET /collection/resource：返回单个资源对象
  • POST /collection：返回新生成的资源对象
  • PUT /collection/resource：返回完整的资源对象
  • PATCH /collection/resource：返回完整的资源对象
  • DELETE /collection/resource：返回一个空文档
restful接口
01-16
使用 PHP(不用框架) 来创建一个 RESTful web service,别人的下载的。 其中nginx 中需要配置rewrite规则： rewrite ^(.*)/site/list/$ $1/RestController.php?view=all last; rewrite ^(.*)/site/list/([0-9]*)/$ $1/RestController.php?view=single&id=$2 last; 项目中的.htaccess文件删除即可。
基于 RESTful 架构的API设计原则和规范.docx
08-13
2. 域名（ROOT URL）：RESTful API 应该使用合理的域名结构，以便于理解和记忆。 3. 版本（Versioning）：RESTful API 应该支持版本控制，以便于管理不同的 API 版本和向后兼容。 4. 路径（Endpoints）：RESTful ...
RESTful 接口规范
weixin_33743880的博客
08-14 163
原文地址：http://www.coderli.com/translate-restful-standard-resolved   OneCoder最近一直在使用Restful API，最近正好看到一篇自定义restful接口规范的“抛砖引玉”得的文章，索性翻译一下，与大家分享。 原文地址：http://java.dzone.com/articles/restful-standard-res...
Restful接口规范
weixin_45683187的博客
11-24 1820
Restful接口的好处是：统一接口、URI。方便接口管理 请求被分为以下几种 get：查询请求 post：新增请求 put：更新请求 delete：删除请求 请求特点为两类 get和delete请求参数写法是一致的（url参数拼接，无请求主体） post和put请求参数写法是一致的（data参数，有请求主体 xhr.send(data)） 响应行为规范 get请求成功时，返回对应的数据，及状态码200 put请求成功时，返回修改的数据，及状态码200 post请求成功时，返回新增的数据，及状态码
RESTful架构实战.docx
11-03
2. 可缓存（Cacheable）：RESTful 架构支持缓存，这可以提高系统的性能。 3. 统一接口（Uniform Interface）：RESTful 架构使用统一的接口来访问资源，这使得系统更加简单和易于维护。 4. 分层系统（Layered System...
RESTful 架构详解 _ 菜鸟教程2
08-04
2. **理解RESTful架构** - **资源（Resource）与URI**：资源是网络上可被访问的任何对象，如用户信息、产品详情等。每个资源都有一个唯一的URI，如`https://example.com/users/123`，用于定位和访问该资源。URI应...
restful接口规范
happyJava
09-03 432
名词资源（Resource）：任何东西都是一种资源，例如，一篇博客文章 表示（Representation）：资源的一种表现形式，例如，JSON、XML URL：每个资源都应该有一个对应的URL URI：URL是URI的一种，URL都有对应的资源，而URI不一定，它强调的是一种资源标识使用协议语义GET：获得一个资源的一种表示 原则上所有的GET操作都是安全操作，意思是GET不会更改数据。但
RESTful接口规范
mophite的博客
11-29 318
RESTful设计： 前后端写接口，需要遵循一个规范，不能想咋样就咋样。 服务器返回的数据尽量是JSON数据格式。 1. 域名 应该尽量将API部署在专用域名之下。 https://api.example.com 如果确定API很简单，不会有进一步扩展，可以考虑放在主域名下。 https://example.org/api/ 2. 版本（Versioning） 应该将API的版本号放入URL。 h...
RESTful接口规范（带案例）
cs_zhao18的博客
12-04 6596
一、主要特征 以资源为基础：资源可以是一个图片、音乐、一个XML格式、HTML格式或者JSON格式等网络上的一个实体，除了一些二进制的资源外普通的文本资源更多以JSON为载体、面向用户的一组数据(通常从数据库中查询而得到)。统一接口: 对资源的操作包括获取、创建、修改和删除，这些操作正好对应HTTP协议提供的GET、POST、PUT和DELETE方法。换言而知，使用RESTful风格的接口但从接口上你可能只能定位其资源，但是无法知晓它具体进行了什么操作，需要具体了解其发生了什么操作动作要从其HTTP请..
RESTful接口规范和详解
jinzhell的博客
09-02 1996
文章目录1、 RESTful概述1.1、 什么是REST1.2、 什么是RESTful1.3、 REST标准规范1.3.1、 REST风格的WEB设计原则1.3.2、 如何统一接口规则2、 REST最佳实践2.1、 接口设计2.2、 响应设计2.2.1、 响应规则2.2.2、 响应字段2.2.3、 响应状态码3、 REST实现用户CRUD3.1、 根据ID查询用户3.2、 查询所有用户3.3、 新增用户3.4、 修改用户3.5、 删除用户 1、 RESTful概述 1.1、 什么是REST 作者： .
RESTful架构
最新发布
04-18
### RESTful架构的核心概念 RESTful架构是一种基于REST（Representational State Transfer，表述性状态转移）原则的架构风格。其核心目标是为网络应用提供一种轻量级、易于扩展的设计模式[^1]。这种架构风格特别适用于分布式系统和大规模互联网环境下的超媒体系统的开发。 #### RESTful架构的关键特性 RESTful架构具有以下几个关键特性： - **资源导向**：所有的操作都围绕着资源展开，而这些资源由唯一的URI（Uniform Resource Identifier，统一资源标识符）来表示[^1]。 - **无状态通信**：客户端与服务器之间的每一次交互都是独立的，不依赖于之前的任何请求或响应[^1]。 - **统一接口**：通过标准化的操作集（GET, POST, PUT, DELETE等），使得客户端可以一致地访问不同的资源[^3]。 #### RESTful架构的设计原则 RESTful架构遵循一组严格的设计原则，以确保系统的可伸缩性和互操作性： 1. **资源识别**：每个资源都有一个唯一标识符（通常是URL）。例如，`/users/{id}` 可以用来获取特定用户的详细信息[^1]。 2. **标准方法**：使用HTTP动词定义对资源的操作行为。常见的HTTP动词及其含义如下： - `GET`: 获取资源数据。 - `POST`: 创建新资源。 - `PUT`: 更新现有资源或创建指定位置的新资源。 - `DELETE`: 删除资源。 这些动词提供了清晰的标准接口，便于不同服务间的协作[^3]。 3. **自描述消息**：每条消息都应该包含足够的信息让接收方能够理解该消息的内容及处理方式。这通常意味着在HTTP头中加入MIME类型和其他元数据[^2]。 4. **按需链接**：利用HATEOAS (Hypermedia As The Engine Of Application State)，即通过返回的数据中的链接引导下一步动作，增强用户体验的同时简化了API文档编写工作流程[^3]。 #### RESTful架构的实现方式 为了有效地实现RESTful API，在技术选型方面可以选择多种编程语言和技术栈支持的服务端框架。对于Java开发者而言，《RESTful API设计与实现：Java开发者指南》一书中提到过一些最佳实践建议[^4]。下面是一个简单的例子展示如何用Spring Boot快速搭建一个基本的RESTful服务: ```java @RestController @RequestMapping("/api/users") public class UserController { @GetMapping("/{id}") public ResponseEntity<User> getUserById(@PathVariable Long id){ User user = userService.findById(id); if(user != null){ return new ResponseEntity<>(user, HttpStatus.OK); }else{ return new ResponseEntity<>(HttpStatus.NOT_FOUND); } } @PostMapping("/") public ResponseEntity<Void> createUser(@RequestBody User newUser){ boolean created = userService.create(newUser); if(created){ URI location = ServletUriComponentsBuilder.fromCurrentRequest().path("/{id}").buildAndExpand(newUser.getId()).toUri(); return ResponseEntity.created(location).build(); }else{ return new ResponseEntity<>(HttpStatus.BAD_REQUEST); } } } ``` 此代码片段展示了两个典型的RESTful API端点——一个是读取单个用户的信息(`GET /api/users/{id}`)，另一个则是新增加一个新的用户记录(`POST /api/users`)。 ### 总结 综上所述，RESTful架构不仅是一套理论上的指导方针，更是在实际工程实践中被广泛采用的一种解决方案。它凭借简单直观的设计理念以及强大的功能表现赢得了众多开发者的青睐。
评论
添加红包

请填写红包祝福语或标题

个

红包个数最小为10个

元

红包金额最低5元

当前余额3.43元 前往充值 >
需支付：10.00元
成就一亿技术人!
领取后你会自动成为博主和红包主的粉丝 规则
hope_wisdom
发出的红包
实付元
使用余额支付
点击重新获取
扫码支付
钱包余额 0

抵扣说明：

1.余额是钱包充值的虚拟货币，按照1:1的比例进行支付金额的抵扣。
2.余额无法直接购买下载，可以购买VIP、付费专栏及课程。

余额充值