RESTFUL服务中的注意事项

2024-06-23 16:32
文章标签 服务 注意事项 restful

本文主要是介绍RESTFUL服务中的注意事项,希望对大家解决编程问题提供一定的参考价值,需要的开发者们随着小编来一起学习吧!

1. POST/PUT/PATCH方法的区别

  • POST:新增一个资源,不用携带id
  • PUT:新增或完整的更新一个资源,必须要携带id及所有属性,如果没有传递某项属性,则表示删除该属性的值
  • PATCH:局部的更新一个资源,必须要携带id及需要修改的属性,如果没有传递某项属性,则表示不改变某项属性的值

特别注意:PUT和PATCH特性的不同,在实现上也有很大区别

在这里思考一种场景:我们需要把一个对象中的部分属性置空,同时改变另一些属性的值,并且我们不希望传递整个对象,该怎么办?

  1. 关于PATCH的深入思考,很深刻:
    《在 RESTful API 设计中使用 PATCH 的最佳实践》 ==> 《原文(好像打不开了)》,《译文》

    文章的主要思想:给接口中的每一个参数都配一个字段,用来表示该参数需要进行操作是:新增值,覆盖原值,合并原值,还是删除原值等等。如下图所示,图标来自原文。
    PATCH 的最佳实践

  2. 我的一点思考,为了应对上述场景,可以对接口进行设计:

    • 当某个字段为null时(即没有传递该字段),表示忽略该字段(即不改变原值);
    • 当某个字段为空(空字符串)时,表示将该字段置null(即删除原值);
    • 当某个字段不为空时,表示修改该字段。
    • 但是,这样也有问题,接口的所有参数都只能先设为字符串类型,然后在用的时候再进行转换。
    • 另一个问题是,这样一来,想把某个字符串类型的属性保存为空字符串就不可能了,对于一些数据库中有的字符串类型的特殊属性而言,null和空字符串都有意义,都有用。
  3. 小结:强行实现这种场景,实际上是对现有的PATCH语义进行了扩充,以实现一种灵活的更新资源的方法。但是我们知道灵活度和复杂度是同生兄弟。灵活度的越高,实现起来越复杂。所以,遵守现有的语义也是一个不错的选择。如果想要对资源进行复杂的跟新操作用PUT,如果只是想简单的更新一些属性用PATCH。

这篇关于RESTFUL服务中的注意事项的文章就介绍到这儿,希望我们推荐的文章对编程师们有所帮助!


原文地址:
本文来自互联网用户投稿,该文观点仅代表作者本人,不代表本站立场。本站仅提供信息存储空间服务,不拥有所有权,不承担相关法律责任。如若转载,请注明出处:http://www.chinasem.cn/article/1087686

相关文章

如何搭建并配置HTTPD文件服务及访问权限控制

《如何搭建并配置HTTPD文件服务及访问权限控制》:本文主要介绍如何搭建并配置HTTPD文件服务及访问权限控制的问题,具有很好的参考价值,希望对大家有所帮助,如有错误或未考虑完全的地方,望不吝赐教... 目录一、安装HTTPD服务二、HTTPD服务目录结构三、配置修改四、服务启动五、基于用户访问权限控制六、

SpringCloud整合MQ实现消息总线服务方式

《SpringCloud整合MQ实现消息总线服务方式》:本文主要介绍SpringCloud整合MQ实现消息总线服务方式,具有很好的参考价值,希望对大家有所帮助,如有错误或未考虑完全的地方,望不吝赐... 目录一、背景介绍二、方案实践三、升级版总结一、背景介绍每当修改配置文件内容,如果需要客户端也同步更新,

linux服务之NIS账户管理服务方式

《linux服务之NIS账户管理服务方式》:本文主要介绍linux服务之NIS账户管理服务方式,具有很好的参考价值,希望对大家有所帮助,如有错误或未考虑完全的地方,望不吝赐教... 目录一、所需要的软件二、服务器配置1、安装 NIS 服务2、设定 NIS 的域名 (NIS domain name)3、修改主

SpringBoot基于配置实现短信服务策略的动态切换

《SpringBoot基于配置实现短信服务策略的动态切换》这篇文章主要为大家详细介绍了SpringBoot在接入多个短信服务商(如阿里云、腾讯云、华为云)后,如何根据配置或环境切换使用不同的服务商,需... 目录目标功能示例配置(application.yml)配置类绑定短信发送策略接口示例:阿里云 & 腾

springboot项目如何开启https服务

《springboot项目如何开启https服务》:本文主要介绍springboot项目如何开启https服务方式,具有很好的参考价值,希望对大家有所帮助,如有错误或未考虑完全的地方,望不吝赐教... 目录springboot项目开启https服务1. 生成SSL证书密钥库使用keytool生成自签名证书将

电脑死机无反应怎么强制重启? 一文读懂方法及注意事项

《电脑死机无反应怎么强制重启?一文读懂方法及注意事项》在日常使用电脑的过程中,我们难免会遇到电脑无法正常启动的情况,本文将详细介绍几种常见的电脑强制开机方法,并探讨在强制开机后应注意的事项,以及如何... 在日常生活和工作中,我们经常会遇到电脑突然无反应的情况,这时候强制重启就成了解决问题的“救命稻草”。那

使用Node.js制作图片上传服务的详细教程

《使用Node.js制作图片上传服务的详细教程》在现代Web应用开发中,图片上传是一项常见且重要的功能,借助Node.js强大的生态系统,我们可以轻松搭建高效的图片上传服务,本文将深入探讨如何使用No... 目录准备工作搭建 Express 服务器配置 multer 进行图片上传处理图片上传请求完整代码示例

Spring LDAP目录服务的使用示例

《SpringLDAP目录服务的使用示例》本文主要介绍了SpringLDAP目录服务的使用示例... 目录引言一、Spring LDAP基础二、LdapTemplate详解三、LDAP对象映射四、基本LDAP操作4.1 查询操作4.2 添加操作4.3 修改操作4.4 删除操作五、认证与授权六、高级特性与最佳

Linux上设置Ollama服务配置(常用环境变量)

《Linux上设置Ollama服务配置(常用环境变量)》本文主要介绍了Linux上设置Ollama服务配置(常用环境变量),Ollama提供了多种环境变量供配置,如调试模式、模型目录等,下面就来介绍一... 目录在 linux 上设置环境变量配置 OllamPOgxSRJfa手动安装安装特定版本查看日志在

SpringCloud之LoadBalancer负载均衡服务调用过程

《SpringCloud之LoadBalancer负载均衡服务调用过程》:本文主要介绍SpringCloud之LoadBalancer负载均衡服务调用过程,具有很好的参考价值,希望对大家有所帮助,... 目录前言一、LoadBalancer是什么?二、使用步骤1、启动consul2、客户端加入依赖3、以服务