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

相关文章

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

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

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

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

Python中__new__()方法适应及注意事项详解

《Python中__new__()方法适应及注意事项详解》:本文主要介绍Python中__new__()方法适应及注意事项的相关资料,new()方法是Python中的一个特殊构造方法,用于在创建对... 目录前言基本用法返回值单例模式自定义对象创建注意事项总结前言new() 方法在 python 中是一个

Springboot的自动配置是什么及注意事项

《Springboot的自动配置是什么及注意事项》SpringBoot的自动配置(Auto-configuration)是指框架根据项目的依赖和应用程序的环境自动配置Spring应用上下文中的Bean... 目录核心概念:自动配置的关键特点:自动配置工作原理:示例:需要注意的点1.默认配置可能不适合所有场景

Nginx配置系统服务&设置环境变量方式

《Nginx配置系统服务&设置环境变量方式》本文介绍了如何将Nginx配置为系统服务并设置环境变量,以便更方便地对Nginx进行操作,通过配置系统服务,可以使用系统命令来启动、停止或重新加载Nginx... 目录1.Nginx操作问题2.配置系统服android务3.设置环境变量总结1.Nginx操作问题

Spring Cloud Hystrix原理与注意事项小结

《SpringCloudHystrix原理与注意事项小结》本文介绍了Hystrix的基本概念、工作原理以及其在实际开发中的应用方式,通过对Hystrix的深入学习,开发者可以在分布式系统中实现精细... 目录一、Spring Cloud Hystrix概述和设计目标(一)Spring Cloud Hystr

springboot的调度服务与异步服务使用详解

《springboot的调度服务与异步服务使用详解》本文主要介绍了Java的ScheduledExecutorService接口和SpringBoot中如何使用调度线程池,包括核心参数、创建方式、自定... 目录1.调度服务1.1.JDK之ScheduledExecutorService1.2.spring

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