百度360必应搜狗淘宝本站头条
当前位置:网站首页 > 技术文章 > 正文

切勿版本化Web API_wps国产化版本

myzbx 2025-10-02 04:23 6 浏览

在最近的一次演讲中,Sebastien Lambla指出,通过在UR中增加版本或者使用带有版本的媒体类型将Web API版本化在开放网络上是行不通的。我们真正需要的是,协定随着我们需要的变化而演化。此外,他还描述了避免版本化需求的方法。

Lambla是一名REST架构风格顾问和倡导者。在他看来,版本化Web API的一个常见的原因是,避免我们使用的协定破坏客户端。我们希望客户端和服务器可以独立地修改,并且能够将API变化传达给客户端开发人员。Lambla认为,从根本上讲,版本化是一种管理耦合的方法,本质上是一种变更控制。

一种版本化方法是在URI中增加版本,像这样:
http://api.equestrian.magic/v1/。这样做的问题是,当URI指向一个资源(比如客户),其变化会导致使用旧的URI无法找到资源,除非我们使用重定向。Lambla强调,资源URI永远都不应该变化,但如果使用一个新版本,它就有两个不同的URI了,这通常表示两种不同的东西,它们之间无法相互关联。

另一种方法是在域名中增加版本:
http://v1.api.equestrian.magic/。这样,在实际创建一个新系统时,URI就会变得难以理解。有多个系统和模型,但都是指向相同的数据模型,这会增加维护的困难。

第三种方法是使用带有版本的媒体类型。Lambla认为,这种方法如今在Web上已经比较少见,但在企业中还相当常见。它以内容协商为基础,在Accept和Content-Type头信息的媒体类型中增加一个版本号:
application/vnd.equestrian.ponies.v1+xml。Lambla指出,不同的版本实际上还是不同的资源,在同一个URI上使用不同的媒体类型会破坏资源标识符。他援引Roy Fielding的话来说明他的观点:

当格式之间的不同实际上只是细节上的差别时,我们鼓励资源所有者仅仅使用真正的内容协商(不使用重定向)

在Lambla看来,在开放网络上,这些版本化技术没有一种可行。我们真正需要的是可以演化的东西,使用可以随着我们需要的变化而平滑演化的协定。在Lambla看来,这是一个很好理解的问题,而且与Web相关;数以百万计的微服务已经运行25年,也没有出现太多的问题,除了HTTP之外,也没有版本化。

可演化协定的第一个基础是向后兼容。Lambla举了HTML的例子。HTML有许多停用的元素,但它们仍然为客户端所支持,因为我们无法升级世界上所有的站点。同样的原则也应该运用在API上,因为它在演化的过程中仍然必须支持旧格式。

第二个基础是向前兼容。为了做到这一点,你必须忽略未知或者没有理解的东西。Lambla举了CSS的例子。在CSS中,新属性会得到处理,没有任何问题。为了做到这一点,未知属性会使用回退原则来处理,这是一种获得扩展点的重要方式。

XML仍然很常用,而且经常和XML模式一起使用。这时,为了支持演化,我们必须保证内容的灵活性。因此,Lambla强烈建议不要在服务器以及客户端上验证模式。相反,我们应该只是找出我们需要的元素和属性,而忽略其他部分。

为了避免版本化,我们需要继续支持所有的特性,但我们不能将所有的变化永远都保留在API中。应该删除很少使用的旧特性。为了知道什么时候可以删除,我们需要使用指标度量使用情况。然后,我们就可以确定,比如,当使用率降到1%以下时,删除特性。

相关推荐

vue3和web网页直接操作微信小程序云开发数据库

我们开发好小程序以后,有时候需要编写一个管理后台网页对数据库进行管理,之前我们只能借助云开发自带的cms网页,但是cms网页设计的比较丑,工作量和代码量也不够,所以我们今天就来带大家实现用vue3编写...

WebCurl:极致轻量的跨平台 HTTP 请求调试工具

在接口开发与测试领域,工具的轻量化、兼容性与安全性往往直接影响工作效率。WebCurl作为一款纯原生、无依赖的网页版API测试与调试工具,凭借极简架构与全场景适配能力,重新定义了接口调试工具的使...

webapi 全流程_webapi项目

C#中的WebAPIMinimalApi没有控制器,普通api有控制器,MinimalApi是直达型,精简了很多中间代码,广泛适用于微服务架构MinimalApi一切都在组控制台应用程序类【Progr...

Nodejs之MEAN栈开发(四)-- form验证及图片上传

这一节增加推荐图书的提交和删除功能,来学习node的form提交以及node的图片上传功能。开始之前需要源码同学可以先在git上fork:https://github.com/stoneniqiu/R...

CodeSpirit.Amis.AiForm 智能表单使用指南

概述AiForm是CodeSpirit.Amis框架的智能表单功能,专为AI驱动的长时间处理任务设计。它自动生成一个多步骤的用户界面,包含表单输入、进度监控、日志显示和结果展示等功能。功能特点...

初级、中级、高级前端工程师,对于form表单实现的区别

在React项目中使用AntDesign(Antd)的Form组件能快速构建标准化表单,特别适合中后台系统开发。以下是结合Antd的最佳实践和分层实现方案:一、基础用法:快速搭...

Bun v0.7 大版本发布,与 Vite 牵手来破局?

大家好,很高兴又见面了,我是"高级前端进阶",由我带着大家一起关注前端前沿、深入前端底层技术,大家一起进步,也欢迎大家关注、点赞、收藏、转发,您的支持是我不断创作的动力。今天给大家带来...

「前端」界面可视化开发框架formio.js

简介formio是一个前端可视化开发框架,无需写css/js就可以开发一套前端界面。直接在界面内拖拽就可以完成界面的布局及开发。数据交互也是固定的,表单校验也可以配置,功能非常强大。特性使用ES6...

小伙给同事爬取数据竟获取不到,竟要使用这种请求方式才能获取?

Http请求中FormData和RequestPayload两种参数的区别?AjaxPost请求中常用的两种的形式:formdata和requestpayload一、默认的表单方式...

WinForm + Win32 API 自定义无边框窗口实战(工业软件必备)

前言随着.NET9.0AOT(Ahead-of-Time)的发布,便萌生了用代码测试AOT编译效果的想法,同时评估未来是否为NanUI开发支持AOT编译的新版本。关于NanUI项目,若大家尚未了...

DeepSeek从入门到精通(11)——网页版、APP、API使用方式比较

DeepSeek提供了三种主要的使用方法:网页版、手机APP和API调用。这三种方式各有特点,适用于不同的使用场景。下面从使用方法和主要特点两方面进行比较:一、网页版使用方法:直接通过浏览器访问De...

初略Web API Notification 桌面通知

HTML5WebNotificationsAPI通知接口用于向用户配置和显示桌面通知弹窗。例如,Email邮件通知、来电提醒、聊天信息提醒或任务提醒等。关于Web开发技术中Notificat...

什么是API网关?——驱动数字化转型的“隐形冠军”

什么是API网关API网关(APIGateway)是一个服务器,位于应用程序和后端服务之间,提供了一种集中式的方式来管理API的访问。它是系统的入口点,负责接收并处理来自客户端的请求,然后将请求路由...

.NET 7使用 Entity Framework Core 制作增删改查(CRUD) Web API 教程

在本文中,我们将使用EntityFrameworkCore(EFCore)实现一个.NET7WebAPICRUD示例。WebAPI是一个构建HTTP服务的框架,可以从浏览器、移动设备和...

C# ASP.NET Core Web Api 与 MVC 模式下 body 参数传递,post 参数方式

在ASP.NETCore中,WebAPI和MVC模式在处理HTTP请求时,特别是POST请求,使用body参数来传递数据的方式非常相似。两者都使用模型绑定来自动将请求体中的数据映射到C#对象上。下...