「第二部:容器和微服务架构](13) API和契约的创建发展和版本控制

简介: 「第二部:容器和微服务架构](13) API和契约的创建发展和版本控制


微服务API是服务与其客户端之间的契约。只有在不破坏微服务的API契约的情况下,您才能独立地开发微服务,这就是契约如此重要的原因。如果您更改合同,它将影响您的客户端应用程序或您的API网关。


API定义的性质取决于您使用的协议。例如,如果您使用消息传递(如AMQP),则API由消息类型组成。如果您使用的是HTTP和RESTful服务,那么API由URL、请求和响应JSON格式组成。


然而,即使您对最初的合同考虑周到,也需要随着时间的推移更改服务API。当这种情况发生时,尤其是当您的API是由多个客户端应用程序使用的公共API时,您通常不能强制所有客户端升级到新的API契约。通常需要以服务契约的旧版本和新版本同时运行的方式增量部署服务的新版本。因此,有一个服务版本控制策略是很重要的。


当API更改很小时,比如向API添加属性或参数,使用旧API的客户机应该切换并使用新版本的服务。您可能能够为所需的任何缺少的属性提供默认值,并且客户端可能能够忽略任何额外的响应属性。


但是,有时需要对服务API进行重大且不兼容的更改。由于您可能无法强制客户端应用程序或服务立即升级到新版本,因此服务必须在一段时间内支持旧版本的API。如果使用基于HTTP的机制(如REST),一种方法是将API版本号嵌入URL或HTTP头中。然后,您可以决定是在同一个服务实例中同时实现两个版本的服务,还是部署每个实例处理一个版本的API。一个很好的方法是中介模式(例如,MediatR库)将不同的实现版本分离成独立的处理程序。


最后,如果您使用的是REST架构,那么超媒体是对服务进行版本控制并允许可演化API的最佳解决方案。


后面会有专门的章节介绍API的版本控制和API的金丝雀部署,消息的版本控制和怎么保证不同版本的消息的兼容。


附加资源


  • 斯科特·汉斯曼 轻松制作ASP.NET Core RESTful Web API版本

http://www.hanselman.com/blog/ASPNETCoreRESTfulWebAPIVersingMadeEasy.aspx

  • 对RESTful Web API的版本控制

http://docs.microsoft.com/azure/architecture/best-practices/api-design

目录
打赏
0
0
0
0
110
分享
相关文章
探索云原生技术:容器化与微服务架构的融合之旅
本文将带领读者深入了解云原生技术的核心概念,特别是容器化和微服务架构如何相辅相成,共同构建现代软件系统。我们将通过实际代码示例,探讨如何在云平台上部署和管理微服务,以及如何使用容器编排工具来自动化这一过程。文章旨在为开发者和技术决策者提供实用的指导,帮助他们在云原生时代中更好地设计、部署和维护应用。
阿里云微服务引擎 MSE 及 云原生 API 网关 2025 年 1 月产品动态
阿里云微服务引擎 MSE 面向业界主流开源微服务项目, 提供注册配置中心和分布式协调(原生支持 Nacos/ZooKeeper/Eureka )、云原生网关(原生支持Higress/Nginx/Envoy,遵循Ingress标准)、微服务治理(原生支持 Spring Cloud/Dubbo/Sentinel,遵循 OpenSergo 服务治理规范)能力。API 网关 (API Gateway),提供 APl 托管服务,覆盖设计、开发、测试、发布、售卖、运维监测、安全管控、下线等 API 生命周期阶段。帮助您快速构建以 API 为核心的系统架构.满足新技术引入、系统集成、业务中台等诸多场景需要
阿里云微服务引擎 MSE 及 云原生 API 网关 2025 年 1 月产品动态
微服务引擎 MSE 及云原生 API 网关 2025 年 1 月产品动态
微服务引擎 MSE 及云原生 API 网关 2025 年 1 月产品动态。
微服务引擎 MSE 及云原生 API 网关 2024 年 12 月产品动态
微服务引擎 MSE 及云原生 API 网关 2024 年 12 月产品动态。
阿里云微服务引擎 MSE 及 云原生 API 网关 2024 年 12 月产品动态
阿里云微服务引擎 MSE 面向业界主流开源微服务项目, 提供注册配置中心和分布式协调(原生支持 Nacos/ZooKeeper/Eureka )、云原生网关(原生支持Higress/Nginx/Envoy,遵循Ingress标准)、微服务治理(原生支持 Spring Cloud/Dubbo/Sentinel,遵循 OpenSergo 服务治理规范)能力。API 网关 (API Gateway),提供 APl 托管服务,覆盖设计、开发、测试、发布、售卖、运维监测、安全管控、下线等 API 生命周期阶段。帮助您快速构建以 API 为核心的系统架构.满足新技术引入、系统集成、业务中台等诸多场景需要
150 12
《docker高级篇(大厂进阶):5.Docker-compose容器编排》包括是什么能干嘛去哪下、Compose核心概念、Compose使用三个步骤、Compose常用命令、Compose编排微服务
《docker高级篇(大厂进阶):5.Docker-compose容器编排》包括是什么能干嘛去哪下、Compose核心概念、Compose使用三个步骤、Compose常用命令、Compose编排微服务
145 24
微服务引擎 MSE 及云原生 API 网关 2024 年 11 月产品动态
微服务引擎 MSE 及云原生 API 网关 2024 年 11 月产品动态。
108 13
阿里云微服务引擎 MSE 及 云原生 API 网关 2024 年 11 月产品动态
阿里云微服务引擎 MSE 面向业界主流开源微服务项目, 提供注册配置中心和分布式协调(原生支持 Nacos/ZooKeeper/Eureka )、云原生网关(原生支持Higress/Nginx/Envoy,遵循Ingress标准)、微服务治理(原生支持 Spring Cloud/Dubbo/Sentinel,遵循 OpenSergo 服务治理规范)能力。API 网关 (API Gateway),提供 APl 托管服务,覆盖设计、开发、测试、发布、售卖、运维监测、安全管控、下线等 API 生命周期阶段。帮助您快速构建以 API 为核心的系统架构.满足新技术引入、系统集成、业务中台等诸多场景需要
《docker高级篇(大厂进阶):5.Docker-compose容器编排》包括是什么能干嘛去哪下、Compose核心概念、Compose使用三个步骤、Compose常用命令、Compose编排微服务
《docker高级篇(大厂进阶):5.Docker-compose容器编排》包括是什么能干嘛去哪下、Compose核心概念、Compose使用三个步骤、Compose常用命令、Compose编排微服务
202 6
探索微服务架构下的API网关设计
在微服务的大潮中,API网关如同一座桥梁,连接着服务的提供者与消费者。本文将深入探讨API网关的核心功能、设计原则及实现策略,旨在为读者揭示如何构建一个高效、可靠的API网关。通过分析API网关在微服务架构中的作用和挑战,我们将了解到,一个优秀的API网关不仅要处理服务路由、负载均衡、认证授权等基础问题,还需考虑如何提升系统的可扩展性、安全性和可维护性。文章最后将提供实用的代码示例,帮助读者更好地理解和应用API网关的设计概念。
108 8
AI助理

你好,我是AI助理

可以解答问题、推荐解决方案等