油炸小可爱|全栈开发必备技能:构建RESTful API的13种最佳实践
Facebook、GitHub、Google以及其他许多巨头都需要一种服务和消费数据的方式 。 在当今的开发环境中 , RESTful API仍然是服务和消费数据的最佳选择之一 。
但是你是否考虑过学习行业标准?设计RESTful API的最佳实践是什么?从理论上讲 , 任何人都可以在不到五分钟的时间内快速启动数据API——无论是Node.js , Golang还是Python 。
我们将探讨在构建RESTful API时应考虑的13种最佳实践 。 但首先 , 让我们快速阐明RESTful API 。
什么是RESTful API?【油炸小可爱|全栈开发必备技能:构建RESTful API的13种最佳实践】RESTful API需要满足以下约束才能被称为RESTful API 。
- 客户端-服务器模型:RESTful API遵循客户端-服务器模型 , 其中服务器为数据提供服务 , 而客户端连接到服务器以使用数据 。 客户端和服务器之间的交互是通过HTTP(S)请求进行的 , 该请求传输了请求的数据 。
- 无状态:更重要的是 , RESTful API应该是无状态的 。 每个请求都被视为独立请求 。 服务器不应跟踪可能影响将来请求结果的任何内部状态 。
- 统一接口:最后 , 一致性定义了客户端和服务器之间的交互方式 。 RESTful API定义了命名资源的最佳实践 , 但定义了允许你修改资源/与之交互的固定HTTP操作 。 可以在RESTful API中访问以下HTTP操作:GET请求:检索资源POST请求:创建资源或将信息发送到APIPUT请求:创建或替换资源PATCH请求:更新现有资源DELETE请求:删除资源
本文为你提供了13种最佳实践的可行清单 。 让我们来探索!
1.正确使用HTTP方法我们已经讨论了可用于修改资源的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.com/addNewAuthor
- api.com/getAuthorByID/3
RESTful API最佳实践描述了端点应以资源名称开头 , 而HTTP操作则描述操作 。 现在我们得到:
- POST api.com/authors
- GET api.com/authors/3
- GET api.com/authors/3/books
- DELETE api.com/authors/3/books/5
推荐阅读
- 油炸小可爱|秒批、曲线、送龙腾!返现3%的华为信用卡来了
- 油炸小可爱|有些吓人!SSD温度超85度,用它之后骤降25度,这下清凉了
- 江水寒|《琉璃》昊辰VS刘学义,粉丝大惊,想不到你是这样一个小可爱
- 油炸小可爱|电动车逮虾户?雅迪冠能T5领衔电动车续航新方案
- 油炸小可爱|黑客大神总结:全端口蜜罐的部署过程与数据分析
- 小呀么小可爱|爆笑GIF:妹子们可得抓紧啊这么大的风别被吹跑了!
- 口感|第1步不是用油炸!多做1步,花菜脆爽不油腻,更好吃做干煸花菜
- 穿搭|T-ara朴孝敏私服穿搭,黑色小皮裙大秀细腿,女神秒变小可爱
- 油炸小可爱|抱歉了,华为P40Pro,你真没我想象中那么优秀
- 小黑裙:趁着夏季还在,小可爱们一起来学白鹿穿小黑裙吧