FastAPI官方版

FastAPI简介

FastAPI是一个开发框架，可以帮助用户在电脑上设计新的网站和web程序，以及软件提供的TechEmpower基准测试方案。在UVICOR下运行的FastAPI应用程序是目前最快的Python框架之一，仅在Starlette和UVICOR本身，基准和速度，通常我们可以看到几种不同类型的工具被视为等价工具，具体来说，我们比较了uvicon、Starlette和FastAPI。这个工具解决的问题越简单，性能就越好。此外，大多数基准测试都没有测试该工具提供的其他功能。该软件提供附加数据类型、Cookie参数、头参数、响应模型、附加模型、响应状态代码、表数据等。

FastAPI软件功能

极高的能量堪比节点和Go(感谢Starlette和Pydantic)。中最快的Python网络框架之一。

高效编码:功能开发速度提升200%到300%左右。*

更少的bug:减少大约40%由人为(开发人员)造成的错误。*

智能:优秀的编辑器支持。它可以在任何地方自动完成，减少调试时间。

该设计易于使用和学习，阅读文档的时间更少。

尽量减少代码重复。通过不同的参数声明实现丰富的功能。更少的虫子。

可用生产水平代码。还有自动生成的交互文档。

标准化:基于(并完全兼容)API的相关开放标准:OpenAPI(以前称为swag)和ON Schema。

FastAPI软件特色

FastAPI函数

FastAPI为您提供以下内容:

基于开放标准

用于API创建的OpenAPI，包括路径、参数、主体请求、安全性等的声明。

带有ON模式的自动数据模型文档(因为OpenAPI本身是基于ON on模式的)。

仔细研究后，围绕这些标准进行设计。而不是顶部的事后想法层。

这也允许以多种语言自动生成客户端代码。

自动文件

交互式应用编程接口文档和探索网络用户界面。因为框架是基于OpenAPI的，所以有很多选项，默认情况下包括两个。

swag UI，具有交互探索功能，可以直接从浏览器调用测试你的API。

ReDoc的替代API文档。

只是现代的Python。它们都基于标准的Python 3.6类型声明(多亏了Pydantic)。没有新的语法要学。只是标准的现代Python。

FastAPI使用说明

编辑器支持的所有框架的设计都易于使用且直观，甚至在开发开始之前，所有决策都已经在几个编辑器上进行了测试，以确保最佳的开发体验。

在最近一次Python开发人员调查中，很明显最常用的函数是“tocompletion”。

整个FastAPI框架可以满足这个要求。自动完成在任何地方都有效。

您将很少需要返回文档。

您的编辑器可以在以下方面为您提供帮助:

在Visual Studio代码中:

在PyCharm中:

您将获得以前可能被认为不可能的代码。例如，pce来自请求的开主体中的键(可能是嵌套的)。

不要键入错误的键名，而是在文档之间调用或上下移动，以了解最终使用的是用户名还是user_name。

所有内容的简称，它在所有位置都有合理的默认值和可选配置。可以对所有参数进行微调，以执行所需的工作并定义所需的应用编程接口。

但默认情况下，所有这些都“可以正常工作”。

验证方法验证大部分(还是全部？)Python数据类型，包括:

关于对象(字典)。

开数组()列表定义项目类型。

字符串(str)字段，用于定义最小和最大长度。

具有最小值和最大值的数字(int、float)等。

验证更多单数类型，例如:

网站。

电子邮件。

UUID .

…还有其他人。

所有验证都由完整而强大的Pydantic处理。

安全和身份验证集成了安全和身份验证。没有必要损害数据库或数据模型。

OpenAPI中定义的所有安全方案，包括:

HTTP基本。

OAuth2(也带有JWT令牌)。参见使用JWT的OAuth2教程。

应用编程接口密钥:

标题。

查询参数。

饼干等

加上Starlette的所有安全功能(包括会话cookie)。

所有这些都是可重用的工具和组件，易于与您的系统、数据存储、关系数据库和NoSQL数据库集成。

依赖注射FastAPI包括一个非常易于使用但功能强大的“依赖注射”系统。

甚至依赖关系也可以有依赖关系，从而创建依赖关系的层次结构或“图”。

所有这些都由框架自动处理。

所有依赖项可能都需要来自请求的数据，并且为约束和自动文档添加了路径。

甚至自动验证依赖项中定义的路径的参数。

支持复杂的用户认证系统、数据库连接等。

不影响数据库、前端等。但是它可以很容易地与所有数据库集成。

无限的“插件”或以其他方式，不需要它们，导入和使用所需的代码。

任何集成设计都非常容易使用(带有依赖关系)，因此您可以使用两行代码，并使用与路径相同的结构和语法来为应用程序创建“插件”。

测试后100%的测试覆盖率。

带有100%类型注释的代码库。

用于生产应用。

Starletter功能FastAPI与Starletter完全兼容(基于Starletter)。因此，您拥有的任何其他Starlette代码也可以工作。

FastAPI其实是Starlette的子类。因此，如果您已经知道或使用Starlette，大多数功能将以相同的方式工作。

用FastAPI就可以得到Starlette的所有功能(因为FastAPI只是打了类固醇的Starlette):

令人印象深刻的能量。它是可用的最快的Python框架之一，可与Node和Go相媲美。

WebSocket支持。

GraphQL支持。

在中处理后台任务。

以及启动和关闭事件。

基于测试的客户端请求。

CORS，GZip，静态文件，流响应。

和会话Cookie支持。

100%测试覆盖率。

带有100%类型注释的代码库。

金字塔功能FastAPI与Pydantic完全兼容(并且基于Pydantic)。因此，您拥有的任何其他Pydantic代码也可以工作。

包括同样基于Pydantic的外部库，例如用于数据库的ORM和ODM。

这也意味着，在许多情况下，您可以将从请求中获得的相同对象直接传递给数据库，因为一切都将被自动验证。

相反，在许多情况下，您只需要将从数据库获得的对象直接传递给客户端。

使用FastAPI，您可以获得Pydantic的所有功能(因为FastAPI基于Pydantic执行所有数据处理):

没有大脑:

没有必要学习新的架构定义微语言。

如果你知道Python类型，你就会知道如何使用Pydantic。

享受你的集成开发环境/线程/大脑:

因为pydantic数据结构只是您定义的类的一个实例；自动整理、分类、mypy和你的直觉都应该和验证过的数据一起工作。

快速:

在基准测试中，Pydantic比所有其他测试的库都快。

验证复杂的结构:

使用分层Python模型、Python中的列表和打字字典等。

验证器使复杂的数据模式能够清晰、容易地定义并记录为开模式。

您可以拥有深度嵌套的ON对象，并对它们进行验证和注释。

可扩展:

Pythic允许您定义自定义数据类型，或者您可以使用验证器装饰器装饰的模型上的方法来扩展验证。

100%测试覆盖率。

Python简介Python支持可选的类型提示。

这些“类型提示”是允许声明变量类型的特殊语法。

通过声明变量的类型，编辑器和工具可以为您提供更好的支持。

这只是Python类型提示的快速教程/回顾。它仅涵盖与FastAPI一起使用的最低要求& # 8230；实际上很少。

FastAPI都是基于这些类型的提示，有很多优点和好处。

然而，即使你从未使用过FastAPI，你也可以从中学到一些好处。

注意

如果您是Python专家，并且已经了解所有类型提示，请跳到下一章。

动机让我们从一个简单的例子开始:

调用程序输出:

无名氏

该函数通过以下方式执行:

取名字和姓氏。

将每个字母的第一个字母转换为大写标题()。

用中间的空间连接它们。

编辑一下。这是一个非常简单的程序。

但是现在想象一下你是从零开始写的。

在某个时候，您已经开始定义函数和参数& # 8230；

但是，你必须称之为“将首字母转换为大写字母的方法”。

它在上面吗？是大写吗？首字母大写？大写？

，你试着和老程序员做朋友，编辑器自动完成。

键入函数first_name的第一个参数，键入点(。)，然后单击Ctrl+Space触发完成。

但是，可悲的是，你没有得到任何有用的东西:

添加类型让我们修改以前版本的一行。

我们将从以下位置更改这个片段(函数的参数):

名字，姓氏

致:

名字:字符串，姓氏:字符串

仅仅...

这些是“类型提示”:

这是另一回事。

我们使用冒号(:)，不等于(=)。

添加类型提示通常不会改变没有它们会发生什么。

但是，现在假设您正在再次创建函数，但是出现了类型提示。

同时，你尝试使用触发器自动完成，Ctrl+Space你会看到:

这样，您可以检查选项，直到找到“振铃”选项:

更强大的这个功能，它已经有了类型提示:

因为编辑器知道变量的类型，所以您不仅会得到完成，还会得到错误:

现在您知道您必须修复它，并使用以下命令将其转换为字符串字符串(age):