提升 API 可靠性的五种方法

API 在我们的数字世界中发挥着关键的作用,使各种不同的应用能够相互通信。然而,这些 API 的可靠性是保证依赖它们的应用程序功能正常、性能稳定的关键因素。本文,我们将探讨提高 API 可靠性的五种主要策略。

1.全面测试

要确保 API 的可靠性,第一步是进行全面的测试。需要进行的测试包括:功能测试以验证 API 的正确运行,集成测试以确保 API 能与其他系统正常协同,以及负载测试以理解 API 在大规模使用下的表现。

自动化测试能在开发周期的早期发现问题,回归测试能保证新的修改不会对现有功能造成破坏。使用虚拟化或模拟技术可以模拟 API 依赖,进行更深度的测试。此外,为了确保 API 的提供者和消费者都能满足约定的接口,契约测试非常重要。

下面我们将使用 Go 的内置 testing 包,通过一个简单的例子对一个假设的 API 端点(用于访问 API 的 URI)进行测试。

假设我们有一个端点 GET /users/{id} ,用于返回用户的详细信息。

下面是我们可能编写的测试代码:

package mainimport (
"net/http"
"net/http/httptest"
"testing"
)// 这是一个简化的实际处理器函数示例
func UserHandler(w http.ResponseWriter, r *http.Request) {
// ... 处理器逻辑
}func TestUserHandler(t *testing.T) {
req, err := http.NewRequest("GET", "/users/1", nil)
if err != nil {
t.Fatal(err)
}rr := httptest.NewRecorder()
handler := http.HandlerFunc(UserHandler)handler.ServeHTTP(rr, req)if status := rr.Code; status != http.StatusOK {
t.Errorf("handler returned wrong status code: got %v want %v",
status, http.StatusOK)
}// 你还可以检查响应体是否符合预期的输出
expected := `{"id": "1", "name": "John Doe"}`
if rr.Body.String() != expected {
t.Errorf("handler returned unexpected body: got %v want %v",
rr.Body.String(), expected)
}
}

这个测试创建了一个新的 HTTP 请求,模拟了对我们的  /users/{id} 端点的调用,然后把请求传递给了处理器函数。测试会检查响应状态是否为  200 OK(即我们期望的成功请求应返回的结果)以及响应体是否与预期的输出一致。

这个例子只是一个简单的示例,在实际应用中,你可能会面临更复杂的场景,包括测试各种边界条件、错误路径等。此外,net/http/httptest 包提供了许多用于测试 HTTP 客户端和服务器的工具。

总之,你可以结合单元测试、性能测试和持续的集成测试,为你的 API 构建一个全面的测试套件。

单元测试的目的是确保你的 API 中每个组件的正确性。它通过验证每个部分的功能和隔离它们,使得你可以在早期发现并纠正问题。单元测试通常通过模拟依赖项并独立测试函数来完成。在 Go 语言中,可以利用诸如 testify 等包来达成这一目标。

性能测试则是为了在高流量的情况下对 API 进行压力测试。这种测试有助于你确定系统在高负载情况下的表现,识别瓶颈,并确保 API 能处理真实世界的使用情况。性能测试可以使用 JMeter 或Gatling 等工具进行。

最后,持续集成测试则通过模拟用户或客户端对 API 进行一系列连续操作,来测试系统的工作流程。这类测试能够提供对端到端工作流程、潜在的障碍或延迟,以及整体用户体验的深入理解。这个过程可以自动化并集成到你的 CI/CD 流程中,使得你可以持续监控并及时反馈任何代码更改的影响。

通过实施包括功能测试、单元测试、性能测试和持续合成测试在内的全面的测试策略,你可以确保你的 API 不仅稳定且高性能,还能为使用者提供无缝的体验。而在问题出现时,这种多元化的测试方法可以帮助你快速定位并解决问题的根源。

2.版本控制

在维护软件系统的稳定性方面,API 版本管理扮演了核心角色。随着时间推移,API 可能会随着需求变化和优化,如果没有适当的版本管理,可能会对现有的客户端应用造成破坏。这就是 API 版本管理的关键所在。通过维护 API 的各个版本,你可以在引入新功能和优化的同时,确保不影响使用旧版本 API 的应用。

这种策略提升了系统的稳定性,因为即使 API 经过改动和优化,客户端应用依然可以稳定运行。它让开发者能够部署 API 更新,而不需要担心这些变化会对正在运行的应用造成破坏,保障了系统的稳定性和正常运行。

保持向后兼容性是实现 API 稳定性的关键一环,也就是说,新系统应能与旧版 API 兼容。即使新的版本发布,使用旧 API 版本的应用依然可以正常运行。这避免破坏用户体验,并给了开发者足够的时间,让他们可以按照自己的节奏更新应用以适应新的 API ,而不是为了防止应用出错而被迫升级。这样做,有助于创建一个整体上更稳定、更强大和更具有弹性的系统。

示例

在 Go 语言中,我们可以使用多种方式来进行 API 的版本管理。

下面这个例子展示了如何通过在 URL 中嵌入 API 版本实现版本管理,这种方法通常被称为"路径版本控制"。

package mainimport (
"fmt"
"net/http"
)func handleRequest(w http.ResponseWriter, r *http.Request) {switch r.URL.Path {
case "/v1/users":
fmt.Fprintf(w, "You've hit the version 1 of the users API!")
case "/v2/users":
fmt.Fprintf(w, "You've hit the version 2 of the users API!")
default:
http.NotFound(w, r)
}
}func main() {
http.HandleFunc("/", handleRequest)
http.ListenAndServe(":8080", nil)
}

在这个例子中,我们定义了一个处理函数,它根据请求的 URL 路径来匹配响应的代码。当访问 "/v1/users" 路径时,我们认为这是对我们 API 第一版本的请求。同样地,"/v2/users" 则对应我们 API 的第二个版本。通过添加更多的分支,你可以轻松地扩展这种模式以适应更多版本和端点。

此外,你也可以通过自定义头部或媒体类型版本管理(也称为"内容协商")来实现版本管理。

不论你选择何种版本管理策略,都应为 API 的每个版本维护清晰且最新的文档,这是一种良好的实践。

但是,我们也需要谨慎使用版本管理。我们应尽可能地保持向后兼容性,并提供清晰的文档。文档应详细说明每个新版本中的变化,并提供废弃旧版本的合理时间表。

3. 面向失败设计

在理想情况下,API 始终能够正确运行。然而在实际操作中,出现失败的情况并不罕见。在设计 API 的过程中,我们需要考虑其容错能力,这可能涉及到诸如优雅降级(即系统继续运行但是功能有所缩减)和故障转移机制(即出现故障时,系统自动切换到备份系统)等策略。

将明确的错误消息和代码纳入 API,能有助于应用程序更好地理解问题所在以及采取应对策略。我们可以通过重试逻辑、速率限制和断路器,让系统从临时性问题中恢复,避免故障级联。

下图显示了应对各种故障类型的操作方法:

示例:断路器模式

在断路器模式中,Go 语言有一个叫 go-hystrix 的热门库,该库专注于延迟和容错处理。它主要是在服务停止时,通过快速失败阻止故障级联。以下是一个基本示例:

package mainimport (
"github.com/afex/hystrix-go/hystrix"
"log"
"net/http"
"errors"
)func main() {
hystrix.ConfigureCommand("my_command", hystrix.CommandConfig{
Timeout:               1000,
MaxConcurrentRequests: 100,
ErrorPercentThreshold: 25,
})http.HandleFunc("/", func(w http.ResponseWriter, r *http.Request) {
err := hystrix.Do("my_command", func() error {
// 调用其他服务
return nil
}, nil)if err != nil {
log.Printf("Failed to talk to other services: %v", err)
http.Error(w, "Failed to talk to other services", http.StatusInternalServerError)
}
})log.Fatal(http.ListenAndServe(":1234", nil))
}

在上述示例中,我们将一个命令封装在 hystrix.Do() 中。如果基于我们设置的参数,传入 Do() 的函数失败或超时,断路器就会被触发,后续的调用将会立即失败,而不再调用该函数。

请注意,这只是一个基本的示例,实际应用场景将涉及更多复杂的用法,需要针对这个库以及其他的弹性实用程序库涉及的各种参数进行细致调整。请务必阅读各种库的文档,深入理解如何在你的代码中有效地使用它们。

4. 监控与分析

实时监控与及时分析对于保证 API 的稳定性至关重要。执行一套全面的 API 监控策略可以包括对运行时间、性能以及错误的检测,这有助于我们在问题扩散影响用户前,及时发现并处理。

同时,深入分析 API 的使用模式可以让我们得到重要的洞察。了解到高峰负载时段、最常使用的端点以及其他使用详情后,您就可以主动地找出可能存在的弱点,并据此进行 API 优化。

选择正确的指标去追踪,对于了解你的 API 的健康状态和性能至关重要。以下是一些需要考虑的关键指标:

1.吞吐量:您的 API 单位时间内处理的请求数量,可以进一步分为端点、HTTP 方法(如 GET、POST、PUT、DELETE 等)或响应状态码。

2.错误率:单位时间内的错误响应数量,通常是指含有 4xx 或 5xx 状态码的响应。同吞吐量一样,这个指标也可以按端点、HTTP 方法或具体的状态码进行细分。

3.延迟:处理一个请求所需的时间,通常以一系列百分位数(如第 50、95 和 99 百分位)来追踪,这可以帮助您了解典型和极端情况下的性能表现。您可能需要针对不同的端点或 HTTP 方法单独追踪此项。

4.流量:发送和接收的数据量,可以按端点、HTTP 方法或响应状态码进行细分。

5.可用性:您的 API 正常运行并能够处理请求的时间占比,可以作为一个整体进行测量,或者针对每一个单独的端点进行测量。

6.饱和度:系统达到最大容量的程度,这可以通过测量 CPU 使用率、内存使用率、磁盘 I/O 或其他可能限制系统处理更多负载的资源来了解。

7.断路器触发:如果您使用断路器模式处理故障,您可能需要追踪断路器被触发的频率,这可以帮助您了解 API 或其依赖项失败的频率。

请记住,根据你的 API 特性和应用需求,选择追踪的具体指标可能会有所不同。关键是要选择那些能为你提供有意义的 API 健康状况和性能洞察力的指标。

以 Prometheus 为例:

Prometheus 是一款内建客户端库的开源系统监控和警告工具包,它支持用各种语言度量您的服务。下面就是一个示例,说明如何使用 Go 客户端库在 HTTP 端点上展示指标。

我们将使用 Prometheus 的 Go 客户端 来展示和创建这些指标。

package mainimport (
"net/http""github.com/prometheus/client_golang/prometheus"
"github.com/prometheus/client_golang/prometheus/promhttp"
)var (
httpRequestsTotal = prometheus.NewCounterVec(
prometheus.CounterOpts{
Name: "http_requests_total",
Help: "Number of HTTP requests",
},
[]string{"path"},
)httpRequestDuration = prometheus.NewSummaryVec(
prometheus.SummaryOpts{
Name: "http_request_duration_seconds",
Help: "Duration of HTTP requests in seconds",
},
[]string{"path"},
)
)func init() {
// Register the metrics.
prometheus.MustRegister(httpRequestsTotal)
prometheus.MustRegister(httpRequestDuration)
}func handler(w http.ResponseWriter, r *http.Request) {
// Increment the counter for the received requests.
httpRequestsTotal.WithLabelValues(r.URL.Path).Inc()// Measure the time it took to serve the request.
timer := prometheus.NewTimer(httpRequestDuration.WithLabelValues(r.URL.Path))
defer timer.ObserveDuration()// Handle the request.
w.Write([]byte("Hello, world!"))
}func main() {http.HandleFunc("/", handler)// Expose the registered metrics via HTTP.
http.Handle("/metrics", promhttp.Handler())
http.ListenAndServe(":8080", nil)
}

在这个例子中,我们创建并注册了两个指标:http_requests_total 和 http_request_duration_seconds。前者是一个计数器,每接收到一个请求就增加一次计数,后者是一个汇总指标,用于记录处理每个请求所花费的时间。

然后,我们创建了一个 HTTP 处理器,每处理一个请求,就会增加计数器并测量请求的执行时长。我们利用 promhttp.Handler() 在 /metrics 端点上展示这些指标。

现在,只要你启动了服务器并向其发送请求,就可以通过访问 http://localhost:8080/metrics 或者使用工具如 curl 来查看这些指标。

这只是一个基础的示例,在实际应用中,你可能会希望追踪更多的指标,并基于其他维度(如 HTTP 方法、响应状态码等)对它们进行细分。

5. 利用 API 网关

API 网关是一种强大的工具,能有效提升 API 的健壮性。作为系统的统一入口,API 网关能够处理诸如路由、负载均衡、认证、限流等多项功能。通过将这些问题从 API 本体中抽离,你能更专注于业务逻辑,而非基础设施。

另外,API 网关还可提供额外的弹性特性,如自动故障转移、为提高性能而对响应进行缓存,以及在高负载时对请求进行缓冲或排队。

下面列出了 API 网关能提供的部分功能,帮助你为技术栈选择适合的 API 网关:

  1. 请求路由: API 网关可以依据请求中的路由信息将客户端请求路由到合适的后端服务。
  2. API 版本管理: API 网关能管理多版本的 API,允许客户端并行使用不同版本。
  3. 限流: 为了避免请求过量淹没后端服务,API 网关能够限制某个或某组客户端的请求速率。
  4. 身份验证和授权: API 网关通常处理客户端请求的身份验证和授权,确保只有经过验证并授权的请求才能到达后端服务。
  5. API 密钥管理: API 网关通常管理 API 密钥,这些密钥用于跟踪和控制 API 的使用方式。
  6. 缓存: 为了提升性能并降低后端服务的负载,API 网关可以缓存后端服务的响应,并在收到相同的请求时返回缓存的响应。
  7. 请求和响应转换: API 网关可以将请求和响应转换为客户端或后端服务所需的格式。
  8. 熔断器功能: 当服务出现故障,API 网关可以通过将请求路由到正常运行的服务来防止应用程序崩溃。
  9. 监控和分析: API 网关能收集 API 的使用和性能数据,用于分析、监控和警报。
  10. 安全策略: API 网关可以执行安全策略,如 IP 白名单,同时防止 SQL 注入、跨站脚本攻击(XSS)等安全威胁。

以下是一些知名的开源 API 网关:

  1. Kong:Kong 是一个云原生、快速、可扩展、分布式的微服务管理层(也称为 API 网关或 API 中间件)。自 2015 年以来,它以开源项目的形式存在,其核心功能是用 Lua 编写的,并运行在 Nginx 网络服务器上。
  2. Tyk:Tyk 是一个开源的 API 网关,运行速度快且可扩展性强,既可以运行在独立服务器上,也可与已有的 Nginx 安装进行协同工作。
  3. Express Gateway:Express Gateway 是一个基于 Express.js 构建的微服务 API 网关。该网关完全可扩展,不依赖任何特定框架,能够在短时间内提供强大且可扩展的解决方案。
  4. KrakenD:KrakenD 是一个高性能的开源 API 网关。KrakenD 消除了所有 SOA 架构的复杂性,以支持应用程序开发者快速发布新功能,同时保持出色的性能。

总的来说,提升 API 的可靠性不是一项一次性任务,而是需要持续投入的工作。这包括严格的测试、精确的版本控制、遵循好的设计原则,智能地使用如 API 网关这样的工具,以及持续的监控和分析。有了这些策略,你就能构建出能经受住时间考验并为你的应用程序提供可靠基础的 API。

原文标题:https://www.codereliant.io/5-ways-to-improve-your-api-reliability/

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

如若内容造成侵权/违法违规/事实不符,请联系多彩编程网进行投诉反馈email:809451989@qq.com,一经查实,立即删除!

相关文章

Seata部署(Centos和Docker)

一、简介 Seata 是一款开源的分布式事务框架。致力于在微服务架构下提供高性能和简单易用的分布式事务服 务。在 Seata 开源之前,Seata 对应的内部版本在阿里经济体内部一直扮演着分布式一致性中间件的⻆ 色,帮助经济体平稳的度过历年的双11&#xff0c…

11 spring-boot的MVC配置原理

11.1 spring-boot为MVC提供的自动配置 1.ContentNegotiatingViewResolver视图解析器; 2.静态资源或者支持WebJars; 3.自动注册类型转换器:比如说前台提交user的字段,后台自动封装的意思; 4.HttpMessageConverters&…

Vue中TodoList案例_勾选

与上一篇Vue中TodoList案例_添加有三个文件变化了 App.vue&#xff1a;中加了checkTodo方法 <template><div id"root"><div class"todo-container"><div class"todo-wrap"><MyHeader :addTodo"addTodo"/&…

Linux学习之case

case的格式如下&#xff1a; case "变量" in值1)指令集1;;值2)指令集2;;*)指令集n;; esaccase会将变量的值跟值1、值2等进行比较&#xff0c;符合就执行后边对应的指令集&#xff0c;注意)只是一个标识&#xff0c;表明这是一个分支&#xff0c;;;是一个分支结束&am…

Sentinel 规则持久化到 Nacos

一、Sentinel规则管理模式&#x1f349; Sentinel的控制台规则管理有三种模式&#xff1a; 原始模式&#x1f95d; 原始模式&#xff1a;控制台配置的规则直接推送到Sentinel客户端&#xff0c;也就是我们的应用。然后保存在内存中&#xff0c;服务重启则丢失 pull模式&#…

对于MyBatis的深入介绍

对于MyBatis的深入介绍 当涉及到数据库操作时&#xff0c;MyBatis是一种广泛使用的ORM&#xff08;对象关系映射&#xff09;框架。MyBatis的主要目标是简化数据库交互&#xff0c;并提供对SQL的灵活控制。下面是对MyBatis的详细介绍&#xff1a; 数据库交互&#xff1a;MyBat…

平台化的测试工具推荐|一站式测试平台RunnerGo

互联网行业的发展到今天越来越多的公司更加注重工作效率和团队协作&#xff0c;越来越多的产品也趋于平台化&#xff0c;平台化也更有利于提高团队效率&#xff0c;代码管理、持续构建、持续部署这些工具的发展都是非常超前的&#xff0c;它们对于团队协作的支持和工作效率的提…

【前端知识】React 基础巩固(三十三)——Redux的使用详解

React 基础巩固(三十三)——Redux的使用详解 Redux的使用详解 针对React 基础巩固&#xff08;三十二&#xff09;中的案例&#xff0c;我们希望抽取页面中共有的代码&#xff08;例如下方的代码&#xff09;&#xff0c;使用高阶组件统一拦截。 constructor() {super();this.…

Packet Tracer – 配置动态 NAT

Packet Tracer – 配置动态 NAT 拓扑图 目标 第 1 部分&#xff1a;配置动态 NAT 第 2 部分&#xff1a;验证 NAT 实施 第 1 部分&#xff1a; 配置动态 NAT 步骤 1&#xff1a; 配置允许的流量。 在 R2 上&#xff0c;为 ACL 1 配置一个语句以允许属于 172.16.0.…

【Docker-compose】基于Docker-compose创建LNMP环境并运行Wordpress网站平台

基于Docker compose创建LNMP环境并运行Wordpress网站平台 1.Docker-Compose概述2. YAML文件格式及编写注意事项3. Docker-Compose配置常用字段4.Docker Compose常用命令5.使用Docker-compose创建LNMP环境&#xff0c;并运行Wordpress网站平台5.1 Docker Compose环境安装5.2 使用…

SpringBoot项目——springboot配置Tomcat两个端口,https和http的方式 jar的打包和运行

目录 引出springboot配置Tomcat两个端口&#xff0c;https和http的方式1.生成SSL证书2.配置client.p12和https端口3.配置http的8080端口WebServerFactoryCustomizer接口4.启动项目 项目应用&#xff1a;在某项目中有一个功能需要https协议Tomcat启动https和http两个端口根据htt…

工业物联网网关让PLC数据手机端监控和报警更加简单

在传统的工厂管理中&#xff0c;我们想要看到现场设备的实时数据&#xff0c;必须在控制室内通过工控机、电脑、触摸屏等这些上位机设备才能看到&#xff0c;同理PLC维护也需要工程师在现场进行编程调试工作&#xff0c;非常不方便。 随着工业物联网的发展&#xff0c;作为设备…

“学习嵌入式开发:明确目标,提升技能“

嵌入式领域涵盖广泛&#xff0c;不可能一次性掌握所有知识。因此&#xff0c;明确学习目标和方向非常重要。选择感兴趣且与职业发展相关的领域进行深入学习是明智之举。 嵌入式技术在不断发展&#xff0c;过去与现在存在差异。选择学习当前行业的主流技术和趋势是明智选择。掌…

抖音矩阵系统源码开发搭建部署分享

一、 功能开发设计 &#xff08;1&#xff09;数据概览&#xff1a;账号&#xff0c;视频top10数据统计 &#xff08;2&#xff09;AI视频创意&#xff1a;原创视频批量剪辑&#xff0c;阶乘算法&#xff0c;去重原理 &#xff08;3&#xff09;同城拓客&#xff1a;线下门店…

【Java基础教程】(四十六)IO篇 · 下:System类对IO的支持:错误输出、信息输出、系统输入,字符缓冲流、扫描流和对象序列化流~

Java基础教程之IO操作 下 &#x1f539;本节学习目标1️⃣ System类对 IO 的支持1.1 错误输出&#xff1a;System.err1.2 信息输出&#xff1a;System.out1.3 系统输入&#xff1a;System. in 2️⃣ 字符缓冲流&#xff1a;BufferedReader3️⃣ 扫描流&#xff1a;Scanner4️⃣…

两个数组的dp问题(2)--动态规划

一)交错字符串: 97. 交错字符串 - 力扣&#xff08;LeetCode&#xff09; 一)确定一个状态标识: 如果我选择s1的一段区间&#xff0c;再进行选择s2得一段区间那么s3这个字符串的长度就已经固定了 预处理:在s1字符串s2字符串和s3字符串前面加上一个虚拟字符&#xff0c;让下标从…

【MyBatis-Plus 进阶学习笔记】

MyBatis-Plus 进阶学习笔记记录 一、 MyBatis Plus 七大功能0. 数据准备1. 逻辑删除2. 自动填充2.1 优化1 自动填充 有的类没有更新和创建时间字段2.2 优化2 自己设置时间时填充自己设置的&#xff0c;不设置时自动填充 3. 乐观锁插件 注&#xff1a;wrapper不能服用4. 性能分析…

网安高级笔记1

html实体编码 HTML实体编码&#xff0c;格式 以&符号开头&#xff0c;以;分号结尾的 HTML 中的预留字符必须被替换为字符实体 在 HTML 中不能使用小于号&#xff08;<&#xff09;和大于号&#xff08;>&#xff09;&#xff0c;这是因为浏览器会误认为它们是…

HTML中的焦点管理

前言 焦点作为页面交互中的重要一环&#xff0c;涉及到的知识点也比较多&#xff0c;有必要做一个统一的总结。 HTML 中的可获取焦点的元素 具有 href 属性的 HTMLAnchorElement/HTMLAreaElement非禁用态的 HTMLInputElement/HTMLSelectElement/HTMLTextAreaElement/HTMLBut…

Docker——compose单机容器集群编排

Docker——compose单机容器集群编排 一、Docker-compose概述1.为何需要Docker-compose2.Docker-compose 的特征3.Docker-compose 的优势4.Docker-compose 的劣势5.Docker-compose 的生产环境 二、Docker Compose 环境安装三、YAML 文件格式及编写注意事项四、Docker Compose配置…