在Python中编写有效的微服务,实用!长文建议收藏!

长文慎入:API First方法结合Connexion是创建高效微服务的强大工具。 API First方法的使用为创建满足客户期望的API带来了好处。 除此之外,使用Connexion将帮助你以平滑的方式在Python中开发API。

Google收购Apigee强调了API在当今应用程序架构中的重要性,使用精心设计的API的微服务对保持业务成功至关重要,因为它简化了复杂软件解决方案的开发。成长型公司会经历来自市场变化和满足客户需求等因素而自然提高的复杂性,类似Zalando这样面临挑战的公司选择了采用微服务,旨在使其更易于构建和维护其应用程序。

微服务是一种将复杂的软件解决方案分解成更小的可组合服务的风格,这些小型服务可以独立维护和部署,每个服务都围绕通常提供REST API的业务功能开发,清晰阐述每个服务提供的功能可以对团队一起构建和维护其微服务的生产力产生巨大影响。微服务开发人员应该向那些负责构建和维护Web、移动或其他服务的客户端开发人员提供如何使用其REST API的描述,未能以清晰的方式描述API以及不能及时更新文档,会导致系统设计被破坏,也使团队成员感到沮丧,构建API First方法就是解决这些问题的方案。

API First方法

API First方法最近已经添加到应用程序开发方法的首要12个因素中 — 一组用于开发强大应用程序的规则和指南,是由一群有丰富经验的开发人员在构建Heroku平台时提出的。它是一种方法,重点是将API规范作为开发过程的第一类工件,是开发人员和团队之间共享的约定。即使在编写第一行代码之前,构建规范就可以促进API的使用者之间的讨论,创建API的模拟,以及生成文档。

Google,IBM,Microsoft和其他公司已经携手创建Open API计划(OAI),以支持、定义和建立一个独立于供应商的格式,用于描述称为Open API Specification(以前称为Swagger 2.0)的REST API。还有其他用于描述API的格式,可以与API First方法一起使用,最着名的是API Blueprint和RAML,但是Open API格式目前拥有更大的用户和支持者社群.按照Open API格式规范编写的API说明,可以容易地生成初始代码,并支持许多语言和框架:Ruby,Java,Node,C#等。对于Python,Connexion是API First开发的最佳选择,因为它既不依赖代码生成也不需要样板代码。

Connexion是一个建立在Flask之上的开源框架,由Zalando创建,它根据API First方法促进Python中微服务的开发,以满足这种解决方案的内部需求。Connexion正在积极发展,我(原文作者)是该项目的主要维护者之一,以及Joao Santos和Henning Jacobs。

在Python中构建一个简单的服务

在Python中构建有效微服务的第一步就是描述在我们的API中使用到的资源,并使用OpenAPI标准描述它们。我们将重点阐述我们的API产生的路由、参数、数据和响应代码。我们从一个简单的节点示例开始,该节点响应字符串“Hello API!”。

在上面的代码段中,我们指定了我们的API有一个节点“/ greeting”,接受请求方法为“GET”,并返回状态码200表示成功。 注意,业务逻辑不在我们的规范中定义,这部分是由我们节点在Python中实现。 “operationId”就是定义对节点进行调用时执行的Python函数。

如你所见,Connexion API处理程序没有范例代码,API调用的处理程序就是返回简单数据结构的普通Python函数。处理程序返回的数据结构可以通过Connexion进行API规范验证(如果指定的话),默认情况下禁用此验证以增加在开发期间的灵活性。现在我们可以通过Connexion将我们的代码通过API规范粘合并运行,最简单的运行方法是使用Connexion CLI工具:

现在我们可以打开浏览器并访问地址http://localhost:5000/greeting,我们应该能看到如下消息:

为了使其更具动态性,我们可以更改规范,为用户名添加HTTP参数。为此,我们的规范应该看起来像这样:

现在Connexion将一个可选参数传递给我们的函数,更改后的Python函数如下:

现在,我们的Python代码和API规范匹配,我们可以重新启动我们的服务器,按Ctrl + C并再次运行以下命令来查看这些更改。

我们的服务器再次监听http://localhost:5000/greeting,此外,现在可以传递可选参数“name”。Connexion包括可在http:// localhost:5000/ui上使用的API控制台界面。默认情况下,启用此控制台UI可以轻松调用API的节点,它也作为我们的微服务的文档。

现在我们知道如何创建Connexion应用程序的基础知识。有关更详细的示例,请检查Github上提供的Connexion示例项目。官方Connexion文档是包含完整的功能信息的资源。在使用Connexion开发RESTful微服务时可作为参考。

向前

企业开始意识到API First方法的好处。Etsy发表了一篇博文,描述了API First方法如何帮助他们通过提供一致的API来解决挑战。在Zalando,API First是他们软件开发生命周期的核心,评审过程的反馈以及创建RESTful微服务的指南都已经开源。

我们可以找到许多支持不同语言的API First方法的开源工具。Connexion是在Python中实现API First方法的完美框架,并且在积极开发中,Connexion不依赖代码,这使得您可以自由地演进您的API规范,而不破坏已经实现的代码。

  • 发表于:
  • 原文链接https://kuaibao.qq.com/s/20181102A1W5IV00?refer=cp_1026
  • 腾讯「云+社区」是腾讯内容开放平台帐号(企鹅号)传播渠道之一,根据《腾讯内容开放平台服务协议》转载发布内容。
  • 如有侵权,请联系 yunjia_community@tencent.com 删除。

扫码关注云+社区

领取腾讯云代金券