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

相关文章

Android 悬浮窗开发示例((动态权限请求 | 前台服务和通知 | 悬浮窗创建 )

《Android悬浮窗开发示例((动态权限请求|前台服务和通知|悬浮窗创建)》本文介绍了Android悬浮窗的实现效果,包括动态权限请求、前台服务和通知的使用,悬浮窗权限需要动态申请并引导... 目录一、悬浮窗 动态权限请求1、动态请求权限2、悬浮窗权限说明3、检查动态权限4、申请动态权限5、权限设置完毕后

SpringBoot中使用 ThreadLocal 进行多线程上下文管理及注意事项小结

《SpringBoot中使用ThreadLocal进行多线程上下文管理及注意事项小结》本文详细介绍了ThreadLocal的原理、使用场景和示例代码,并在SpringBoot中使用ThreadLo... 目录前言技术积累1.什么是 ThreadLocal2. ThreadLocal 的原理2.1 线程隔离2

TP-Link PDDNS服将于务6月30日正式停运:用户需转向第三方DDNS服务

《TP-LinkPDDNS服将于务6月30日正式停运:用户需转向第三方DDNS服务》近期,路由器制造巨头普联(TP-Link)在用户群体中引发了一系列重要变动,上个月,公司发出了一则通知,明确要求所... 路由器厂商普联(TP-Link)上个月发布公告要求所有用户必须完成实名认证后才能继续使用普联提供的 D

微服务架构之使用RabbitMQ进行异步处理方式

《微服务架构之使用RabbitMQ进行异步处理方式》本文介绍了RabbitMQ的基本概念、异步调用处理逻辑、RabbitMQ的基本使用方法以及在SpringBoot项目中使用RabbitMQ解决高并发... 目录一.什么是RabbitMQ?二.异步调用处理逻辑:三.RabbitMQ的基本使用1.安装2.架构

Java中使用Java Mail实现邮件服务功能示例

《Java中使用JavaMail实现邮件服务功能示例》:本文主要介绍Java中使用JavaMail实现邮件服务功能的相关资料,文章还提供了一个发送邮件的示例代码,包括创建参数类、邮件类和执行结... 目录前言一、历史背景二编程、pom依赖三、API说明(一)Session (会话)(二)Message编程客

windos server2022的配置故障转移服务的图文教程

《windosserver2022的配置故障转移服务的图文教程》本文主要介绍了windosserver2022的配置故障转移服务的图文教程,以确保服务和应用程序的连续性和可用性,文中通过图文介绍的非... 目录准备环境:步骤故障转移群集是 Windows Server 2022 中提供的一种功能,用于在多个

解决systemctl reload nginx重启Nginx服务报错:Job for nginx.service invalid问题

《解决systemctlreloadnginx重启Nginx服务报错:Jobfornginx.serviceinvalid问题》文章描述了通过`systemctlstatusnginx.se... 目录systemctl reload nginx重启Nginx服务报错:Job for nginx.javas

Idea调用WebService的关键步骤和注意事项

《Idea调用WebService的关键步骤和注意事项》:本文主要介绍如何在Idea中调用WebService,包括理解WebService的基本概念、获取WSDL文件、阅读和理解WSDL文件、选... 目录前言一、理解WebService的基本概念二、获取WSDL文件三、阅读和理解WSDL文件四、选择对接

使用SpringBoot创建一个RESTful API的详细步骤

《使用SpringBoot创建一个RESTfulAPI的详细步骤》使用Java的SpringBoot创建RESTfulAPI可以满足多种开发场景,它提供了快速开发、易于配置、可扩展、可维护的优点,尤... 目录一、创建 Spring Boot 项目二、创建控制器类(Controller Class)三、运行

python安装完成后可以进行的后续步骤和注意事项小结

《python安装完成后可以进行的后续步骤和注意事项小结》本文详细介绍了安装Python3后的后续步骤,包括验证安装、配置环境、安装包、创建和运行脚本,以及使用虚拟环境,还强调了注意事项,如系统更新、... 目录验证安装配置环境(可选)安装python包创建和运行Python脚本虚拟环境(可选)注意事项安装