DevOps之API管理-阿里云开发者社区

开发者社区> 云焕Max> 正文

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 或小程序等。


版权声明:本文内容由阿里云实名注册用户自发贡献,版权归原作者所有,阿里云开发者社区不拥有其著作权,亦不承担相应法律责任。具体规则请查看《阿里云开发者社区用户服务协议》和《阿里云开发者社区知识产权保护指引》。如果您发现本社区中有涉嫌抄袭的内容,填写侵权投诉表单进行举报,一经查实,本社区将立刻删除涉嫌侵权内容。

相关文章
阿里云服务器怎么设置密码?怎么停机?怎么重启服务器?
如果在创建实例时没有设置密码,或者密码丢失,您可以在控制台上重新设置实例的登录密码。本文仅描述如何在 ECS 管理控制台上修改实例登录密码。
9591 0
windows server 2008阿里云ECS服务器安全设置
最近我们Sinesafe安全公司在为客户使用阿里云ecs服务器做安全的过程中,发现服务器基础安全性都没有做。为了为站长们提供更加有效的安全基础解决方案,我们Sinesafe将对阿里云服务器win2008 系统进行基础安全部署实战过程! 比较重要的几部分 1.
9079 0
阿里云服务器如何登录?阿里云服务器的三种登录方法
购买阿里云ECS云服务器后如何登录?场景不同,阿里云优惠总结大概有三种登录方式: 登录到ECS云服务器控制台 在ECS云服务器控制台用户可以更改密码、更换系.
13301 0
如何设置阿里云服务器安全组?阿里云安全组规则详细解说
阿里云安全组设置详细图文教程(收藏起来) 阿里云服务器安全组设置规则分享,阿里云服务器安全组如何放行端口设置教程。阿里云会要求客户设置安全组,如果不设置,阿里云会指定默认的安全组。那么,这个安全组是什么呢?顾名思义,就是为了服务器安全设置的。安全组其实就是一个虚拟的防火墙,可以让用户从端口、IP的维度来筛选对应服务器的访问者,从而形成一个云上的安全域。
7396 0
阿里云ECS云服务器初始化设置教程方法
阿里云ECS云服务器初始化是指将云服务器系统恢复到最初状态的过程,阿里云的服务器初始化是通过更换系统盘来实现的,是免费的,阿里云百科网分享服务器初始化教程: 服务器初始化教程方法 本文的服务器初始化是指将ECS云服务器系统恢复到最初状态,服务器中的数据也会被清空,所以初始化之前一定要先备份好。
7016 0
阿里云服务器如何登录?阿里云服务器的三种登录方法
购买阿里云ECS云服务器后如何登录?场景不同,云吞铺子总结大概有三种登录方式: 登录到ECS云服务器控制台 在ECS云服务器控制台用户可以更改密码、更换系统盘、创建快照、配置安全组等操作如何登录ECS云服务器控制台? 1、先登录到阿里云ECS服务器控制台 2、点击顶部的“控制台” 3、通过左侧栏,切换到“云服务器ECS”即可,如下图所示 通过ECS控制台的远程连接来登录到云服务器 阿里云ECS云服务器自带远程连接功能,使用该功能可以登录到云服务器,简单且方便,如下图:点击“远程连接”,第一次连接会自动生成6位数字密码,输入密码即可登录到云服务器上。
22016 0
阿里云服务器ECS登录用户名是什么?系统不同默认账号也不同
阿里云服务器Windows系统默认用户名administrator,Linux镜像服务器用户名root
4109 0
+关注
云焕Max
云原生PaaS产品All in
31
文章
15
问答
文章排行榜
最热
最新
相关电子书
更多
《2021云上架构与运维峰会演讲合集》
立即下载
《零基础CSS入门教程》
立即下载
《零基础HTML入门教程》
立即下载