DevOps之API管理

简介: API驱动测试开发

最近几年,软件架构也在不断升级,逐渐采用前后端分离、微服务的体系结构。前后端分离使得前端和后端充分解耦,在高并发情况下,后端可以按需扩展,前端和后端通过 API 接口定义的契约进行通信。API 接口也会随着业务需求的变化不断改变,但 API 接口改变但调用方没有改变时就使得软件不可用。另外,调用方也不了解有哪些 API 接口可以使用,使用的规范是什么,由此也导致了很多管理问题。


API 管理,就是要将 API 的生命周期、API 的注册、使用、版本等管理起来,为调用方提供统一的 API 管控平台。


什么是 API 管理?


API 是 Application Programming Interface(应用编程接口)的简称。API 用于将应用程序本身的能力和数据提供给用户使用,比如微信的 openAPI 接口,高德地图的 openAPI 接口等。用户使用这些 API 可以开发出更具创新的应用程序,提供更丰富的用户体验。


API 管理就是有效管理企业内外部各服务提供的 API 接口。

管理 API 接口的创建、测试、发布等生命周期,以及 API 接口的版本、并提供 API 开发者门户供开发人员查看。服务的 API 接口在构建时自动的注册到 API 管理平台的 API Gateway 中,其他调用方可以通过 API Gateway 访问这些接口提供的服务,并基于 API Gateway 进行 API 的自动化测试,保证 API 的正确性和健壮性。


RESTful API

目前最常用的 API 架构风格是 REST API。它没有严格的标准,但提供了一些要遵循的指导原则和约束条件。


通过遵循 REST 的原则并将其应用于 HTTP 等无状态协议,开发人员可以构建出从任何设备和操作系统调用的 API 接口。API 接口是客户端与服务器端通信的桥梁,设计良好的 RESTful API 是微服务时代企业应用程序成功的必备条件。


REST的原则

  • 统一接口描述:统一接口用于定义客户端和服务器端之间通信的契约。该契约规定了交互的机制和格式以及客户端如何访问服务器端资源。只要遵循该契约,客户端和服务器端的应用程序就可以独立开发,有利于构建前后端分离的架构。


  • 客户端-服务器端:客户端和服务器端这种调用约束构建了松耦合和可扩展的 Web 体系结构。只要客户端和服务器端都遵循统一的接口,他们就可以独立开发,不管使用的是何种开发语言。


  • 无状态:无状态是 RESTful 服务的重要原则。它规定 Web 服务器不需要记住客户端的状态。状态信息可以作为变量包含在 URL 中,也可以作为查询参数、Header 参数或者请求体。服务器处理后,通过 Header 和响应体返回给客户端。这样做有助于减少服务器端维护和传输客户端状态的负担,从而提高服务器端的可伸缩性。


  • 可缓存性:缓存是 RESTful 服务的另一个原则。它提高了服务器端应用程序的可伸缩性和整体性能。一般情况下,服务器端可以指定缓存响应的有效期。根据有效期,客户端决定是使用缓存响应还是单独请求获取实时数据。缓存响应数据可以提高客户端的响应速度。


  • 分层系统:是指在客户端应用与服务器端之间增加一个中间层,一般为代理或网关。可以用于实现安全性、缓存、流量限制、负载均衡等。在中间层实现缓存和负载均衡可以提高系统的可伸缩性。


RESTful API 的最佳实践

API 的设计应该简单而直观的,这样开发人员才能更容易的使用。下面总结了一些设计 RESTful API 的简易方法。


  • 使用 RESTful URL 设计 API。根据资源的逻辑分组设计 API。API URL 应指向资源/子资源的集合或者集合中的单个实体。例如 /customers 指向了客户集合,而 /customers/{customerId} 指向了客户集合中的单个客户实体。


  • 使用 HTTP 动词对资源执行 CRUD 操作。使用 POST 用于创建新资源,GET 用于读取资源,PUT 用于更新资源,DELETE 用于删除资源。另外,可以考虑使用 PATCH 对部分资源更新。


  • 当 HTTP 动词无法映射到操作时,使用 URL 中的操作。有时候,对资源的操作无法映射到 HTTP 动词,比如:register、activate 等操作不能直接映射到 HTTP 动词。这些操作可能适用于单个资源或者一组资源集合。这时,可以将该操作视为 URL 中的一个子资源或者一个资源的一个动作。例如:/customers/123/activate 或者 /customers/123/actions:activate。


  • API 版本。版本控制提供了一种平滑升级和迭代 API 的方法。可以同时支持多个版本的 API,这样就为客户端升级到新版本和注销旧版本提供了时间。最常用的版本控制的方法是在 URL 路径中包含版本信息。


微服务API平台架构

为了满足用户的需求,企业需要以敏捷、灵活、安全和可扩展的方式提供数据和服务。API 是企业对外提供数据和服务的通道。它允许应用程序可以使用像 HTTP 这样轻量级的协议实现通信。随着 API 的不断增加,对 API 的管理就变得格外重要。开头介绍了 API 管理包含的功能,下面介绍一下 API 管理平台的架构图。

image.png


结构图所示包含两个部分:API 管理控制台和API Gateway。


API 管理控制台:


包含 API 声明周期的管理、API 开发者门户等功能。API 创建完成后通过自动化的方式注册到 API Gateway 中并在管理控制台中以待测试的状态显示。测试完成的 API 以待发布的状态显示,发布完成的 API 以已发布的状态显示。在管理控制台中能清晰的展示 API 的提供者、API 的状态、API 的测试报告等信息。API 管理控制台的用户为 API 的使用者、提供者和管理者。


API Gateway:


负责转发其他服务的 API 请求并对请求做拦截处理。API 部署到环境中时会注册到 API Gateway 中,其他客户端可以通过 API Gateway 调用后台的服务,完成 API 接口的自动化测试和性能测试。API Gateway 的调用者为 App、Web 或小程序等。


目录
相关文章
|
4天前
|
Linux API 数据安全/隐私保护
【Linux 用户管理】Linux用户身份信息获取与管理API 接口
【Linux 用户管理】Linux用户身份信息获取与管理API 接口
30 0
|
6月前
|
Java API Maven
淘东电商项目(05) - Swagger及网关统一管理API
淘东电商项目(05) - Swagger及网关统一管理API
75 0
|
4天前
|
安全 大数据 API
elasticsearch|大数据|elasticsearch的api部分实战操作以及用户和密码的管理
elasticsearch|大数据|elasticsearch的api部分实战操作以及用户和密码的管理
84 0
|
4天前
|
存储 自然语言处理 搜索推荐
Elasticsearch 8.10 同义词管理新篇章:引入同义词 API
Elasticsearch 8.10 同义词管理新篇章:引入同义词 API
15 0
|
4天前
|
前端开发 JavaScript API
React的Context API:全局状态管理的利器
【4月更文挑战第25天】React的Context API解决了深层组件间状态共享的难题,提供全局状态管理方案。通过`Provider`和`Consumer`组件,或结合`useContext` Hook,实现状态在组件树中的传递。最佳实践包括避免过度使用,分离逻辑,以及在必要时与Redux或MobX结合。Context API简化了数据传递,但需谨慎使用以保持代码清晰。
|
4天前
|
JSON JavaScript API
访问REST API:在Vue中消费和管理远程数据
【4月更文挑战第23天】本文探讨了在Vue应用中高效访问REST API的方法,包括选择合适的API、使用Axios或Fetch发送请求、封装API服务、处理响应和数据、错误管理及性能优化。关键点在于创建服务层封装请求,使用计算属性和方法处理数据,以及实施错误处理和性能提升策略。通过这些最佳实践,开发者能更好地管理和消费远程数据,构建出动态、响应式的Vue应用。
|
4天前
|
供应链 数据挖掘 API
淘宝API接口系列:数据分析丨Erp上货丨维权控价丨商品搬家丨店铺订单管理
淘宝API接口系列在多个方面为电商业务提供了强大的支持,包括数据分析、ERP上货、维权控价、商品搬家以及店铺订单管理。下面将针对这些方面逐一进行说明。
|
4天前
|
Linux API 网络架构
Rest API请求管理最佳实践:RestClient-cpp库的应用案例
Rest API请求管理最佳实践:RestClient-cpp库的应用案例
|
6月前
|
Java API Maven
微服务技术系列教程(27) - SpringCloud- Zuul整合Swagger管理微服务所有API
微服务技术系列教程(27) - SpringCloud- Zuul整合Swagger管理微服务所有API
61 0
|
4天前
|
监控 供应链 测试技术
如何利用API接口进行高效的商品变体管理?
要利用API接口进行高效的商品变体管理,您需要执行一系列策略和技术步骤来确保数据的准确性和实时性。以下是详细的指南: