RESTful设计方法

最新推荐文章于 2024-09-18 09:49:25 发布
最新推荐文章于 2024-09-18 09:49:25 发布
阅读量314 收藏
点赞数 1
分类专栏： RESTful风格 文章标签： python restful web开发
版权声明：本文为博主原创文章，遵循 CC 4.0 BY-SA 版权协议，转载请附上原文出处链接和本声明。
本文链接：https://blog.csdn.net/weixin_44799217/article/details/118758959
版权

1. 域名

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

https://api.example.com

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

https://example.org/api/

2. 版本（Versioning）

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

http://www.example.com/app/1.0/foo

http://www.example.com/app/1.1/foo

http://www.example.com/app/2.0/foo

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

因为不同的版本，可以理解成同一种资源的不同表现形式，所以应该采用同一个URL。版本号可以在HTTP请求头信息的Accept字段中进行区分（参见Versioning REST Services）：

Accept: vnd.example-com.foo+json; version=1.0

Accept: vnd.example-com.foo+json; version=1.1

Accept: vnd.example-com.foo+json; version=2.0

3. 路径（Endpoint）

路径又称"终点"（endpoint），表示API的具体网址，每个网址代表一种资源（resource）

(1) 资源作为网址，只能有名词，不能有动词，而且所用的名词往往与数据库的表名对应。

举例来说，以下是不好的例子:

/getProducts
/listOrders
/retreiveClientByOrder?orderId=1

对于一个简洁结构，你应该始终用名词。 此外，利用的HTTP方法可以分离网址中的资源名称的操作。

GET /products ：将返回所有产品清单
POST /products ：将产品新建到集合
GET /products/4 ：将获取产品 4
PATCH（或）PUT /products/4 ：将更新产品 4

(2) API中的名词应该使用复数。无论子资源或者所有资源。

举例来说，获取产品的API可以这样定义

获取单个产品：http://127.0.0.1:8080/AppName/rest/products/1
获取所有产品: http://127.0.0.1:8080/AppName/rest/products

4. HTTP动词

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

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

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

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

  • PATCH（UPDATE）：在服务器更新(更新)资源（客户端提供改变的属性）。
  • 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：删除某个指定动物园的指定动物

5. 过滤信息（Filtering）

如果记录数量很多，服务器不可能都将它们返回给用户。API应该提供参数，过滤返回结果。【以查询字符串的形式进行传递】

下面是一些常见的参数。

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

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

6. 状态码（Status Codes）

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

  • 200 OK - [GET]：服务器成功返回用户请求的数据
  • 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 - [*]：服务器发生错误，用户将无法判断发出的请求是否成功。

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

7. 错误处理（Error handling）

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

{
    error: "Invalid API key"
}

8. 返回结果

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

  • GET /collection：返回资源对象的列表（数组）
  • GET /collection/resource：返回单个资源对象
  • POST /collection：返回新生成的资源对象
  • PUT /collection/resource：返回完整的资源对象
  • PATCH /collection/resource：返回完整的资源对象
  • DELETE /collection/resource：返回一个空文档

9. 其他

服务器返回的数据格式，应该尽量使用JSON，避免使用XML。

IT之一小佬
关注
专栏目录
Restful API的设计与实践
虫草
12-08 1673
Restful这个名称应该很多人都不陌生，但是我发现不少人对Restful存在或多或少的理解偏差，其中不泛比较厉害的程序员，所以有必要为Restful来“正名”。Restful是一种软件架构风格，设计风格而不是标准，只是提供了一组设计原则和约束条件。它主要用于客户端和服务器交互类的软件。基于这个风格设计的软件可以更简洁，更有层次，更易于实现缓存等机制。（详见百度百科介绍）Restful的关键是抽取资
Restful设计风格与方法
weixin_40226313的博客
06-27 270
RESTful设计方法1. 域名应该尽量将API部署在专用域名之下。https://api.example.com如果确定API很简单，不会有进一步扩展，可以考虑放在主域名下。https://example.org/api/2. 版本（Versioning）应该将API的版本号放入URL。http://www.example.com/app/1.0/foohttp://www.example.co...
Web后端开发技术：RESTful 架构详解
最新发布
百锦再的博客
09-18 2万+
RESTful 是一种基于（表述性状态转移，Representational State Transfer）架构风格的 API 设计方式，通常用于构建，特别是在 Web 应用开发中广泛应用。REST 是一种轻量级的架构模式，利用标准的 HTTP 协议来实现服务器和客户端之间的通信。RESTful API 是基于资源的操作，通过 URI（统一资源标识符）定位资源，通过 HTTP 方法（GET、POST、PUT、DELETE 等）操作资源，并使用标准的 HTTP 状态码来反馈操作结果。
RESTful 设计方法
没有撤退可言.
07-23 201
RESTful设计方法 1. 域名 应该尽量将API部署在专用域名之下。 https://api.example.com 如果确定API很简单，不会有进一步扩展，可以考虑放在主域名下。 https://example.org/api/ 2. 版本（Versioning） 应该将API的版本号放入URL。 http://www.example.com/app/1.0/foo http://www.example.com/app/1.1/foo http://www.example
基于Restful接口调用方法总结(超详细)
08-29
Restful接口调用方法总结是一种 moderne Web服务开发中的重要设计模式，它可以帮助开发者快速构建可扩展、灵活的Web服务。通过了解Restful接口调用方法总结的原理和实现，可以更好地应用于实际项目中。
RESTful API 设计最佳实践
03-20
2. **HTTP方法**：RESTful设计利用HTTP方法（GET, POST, PUT, PATCH, DELETE）来表示不同的操作。这些方法对应于CRUD（Create, Read, Update, Delete）操作： - **GET**：用于获取资源的表示，如获取所有tickets...
RESTful API设计规范
03-15
RESTful设计的核心理念在于面向资源，通过统一的接口来描述对资源的操作，从而简化开发流程并提高系统的可伸缩性。 #### 二、RESTful设计的基本概念和准则 1. **资源(Resource)**：在RESTful架构中，所有网络上的...
RESTful API设计基础知识
07-06
本文将深入探讨RESTful API设计的基础知识，包括其核心概念、原则和最佳实践。 REST（Representational State Transfer，表现层状态转移）是一种架构风格，源于Web的原始设计原则，由Roy Fielding在他的博士论文中...
RESTful 接口设计
花铛
04-28 581
REST 全称是 Representational State Transfer，中文意思是表述性状态转移。 REST 在2000年被提出，基于HTTP、URI、XML、JSON等标准和协议，支持轻量级、跨平台、跨语言的架构设计。简而言之，REST 指的是一组架构约束条件和原则。 如果一个架构符合 REST 的约束条件原则，就称它为 RESTful 架构。 一句话概括：看 URI 就知道要什么资源，看 http method 就知道要干什么，看 http status code 就知道结果如何。 RE
restful 设计
m0_72440934的博客
06-30 252
restful
RESTful设计
D先生的博客
10-12 940
关于REST的URI设计 1、URI中不应该包含动词 因为"资源"表示一种实体，所以应该是名词，URI不应该有动词， 动词应该放在HTTP协议中。 举例来说，某个URI是/posts/show/1，其中show是动词，这个URI就设计错了，正确的写法应该是/posts/1，然后用GET方法表示show。 如果某些动作是HTTP动词表示不了的，你就应该把动作做成一种资源。比如网上汇款，从账户1向账户...
Restful Web服务如何设计
FantasyBaby的博客
11-18 294
Rest基于Roy Thomas Fielding博士论文 中文翻译 原版论文 从下面几个方面来设计一个好的restful web服务 识别资源 选择合适的资源粒度 设计 URI 选择合适的 HTTP ⽅法和返回码 设计资源的表述 1.识别资源 找到领域名词: 能⽤ CRUD 操作的名词. 比如用户,账户 将资源组织为集合（即集合资源） 将资源组合到一起,比如用户集合 将资源合并为复合资源将用户和账户组合 计算或处理函数使用资源计算处理逻...
RESTful API 设计实战与最佳实践
鉴权是RESTful API设计中的另一个关键环节，常见的方法有OAuth2、JWT（JSON Web Tokens）等。设计时要考虑安全性，防止未授权访问，同时保持API的易用性。例如，使用JWT可以让客户端在登录后获取一个令牌，然后在...
评论
添加红包

请填写红包祝福语或标题

个

红包个数最小为10个

元

红包金额最低5元

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

抵扣说明：

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

余额充值