Discuz! Board

 找回密码
 立即注册

QQ登录

只需一步,快速开始

搜索
热搜: 活动 交友 discuz
查看: 39|回复: 0

构建 RESTful API 的 13 个最佳实践

[复制链接]

1

主题

1

帖子

5

积分

新手上路

Rank: 1

积分
5
发表于 2024-1-16 13:41:56 | 显示全部楼层 |阅读模式
Facebook、GitHub、谷歌和许多其他巨头需要一种服务和消费数据的方法。RESTful API 仍然是当今开发环境中提供和使用数据的最佳选择之一。 Backward Skip 10s Play Video Forward Skip 10s 但您是否考虑过了解行业标准?设计 RESTful API 的最佳实践是什么?理论上,任何人都可以在不到五分钟的时间内快速启动数据 API——无论是 Node.js、Golang 还是 Python。 我们将探讨构建 RESTful API 时应考虑的 13 种最佳实践。对于刚接触 REST API 世界的人,请查看什么是 REST API?以获得介绍和易于理解的示例。 设计第一个 RESTful API 的最佳实践 本文向您展示了 13 条最佳实践的可行列表。让我们来探索一下吧! 1.正确使用HTTP方法 Learn to Code with JavaScript 我们已经讨论了可用于修改资源的可能的 HTTP 方法:GET、POST、PUT、PATCH 和 DELETE。 尽管如此,许多开发人员仍然倾向于滥用 GET 和 POST,或者 PUT 和 PATCH。


我们经常看到开发人员使用 POST 请求来检索数据。此外,我们看到开发人员使用 PUT 请求来替换资源,而他们只想更新该资源的单个字段。 确保使用正确的 HTTP 方法,因为这会给使用 RESTful API 的开发人员带来很多困惑。最好坚持预期的指导方针。 2. 命名约定 了解 RESTful API 命 黎巴嫩电话号码表 名约定将有助于您以有组织的方式设计 API。根据您所服务的资源设计 RESTful API。 例如,您的 API 管理作者和书籍(是的,一个经典示例)。现在,我们要添加新作者或访问 ID 为作者的作者3。您可以设计以下路线来达到此目的想象一下一个 API,它托管许多资源,每个资源都有许多属性。可能的端点列表将变得无穷无尽,并且不太用户友好。因此,我们需要一种更有组织性和标准化的方式来设计 API 端点。 RESTful API 最佳实践描述端点应以资源名称开头,而 HTTP 操作则描述操作。现在我们得到:如果我们想访问具有 ID 的作者3写过的所有书籍怎么办?同样针对这种情况。



有一个解决方案: 获取 最后,如果您想删除 ID5为作者的 ID 为 的书籍,该怎么办3?再次,让我们遵循相同的结构化方法来形成以下端点: 删除 简而言之,利用HTTP操作和资源映射的结构化方式形成可读可理解的端点路径。这种方法的一大优点是,每个开发人员都了解 RESTful API 的设计方式,并且他们可以立即使用该 API,而无需阅读每个端点上的文档。 3.使用多元资源 资源应始终使用复数形式。为什么?想象一下您想要检索所有作者。因此,您将调用以下端点。 当您阅读请求时,您无法判断 API 响应是仅包含一位作者还是所有作者。因此,API 端点应该使用多个资源。 4.状态码的正确使用 状态代码在这里不仅仅是为了好玩。他们有明确的目的。状态代码通知客户端其请求成功。 Learn to Code with JavaScript 最常见的状态代码类别包括: 200(OK):请求已成功处理并完成。 201(已创建):表示资源创建成功。 400(Bad Request):表示客户端错误。

回复

使用道具 举报

您需要登录后才可以回帖 登录 | 立即注册

本版积分规则

Archiver|手机版|小黑屋|Comsenz Inc.

GMT+8, 2024-5-5 03:24 , Processed in 0.048219 second(s), 18 queries .

Powered by Discuz! X3.4

© 2001-2017 Comsenz Inc.

快速回复 返回顶部 返回列表