高性能API接口构建框架：fastapi

fastapi简介：

FastAPI 是一个用于构建 API 的现代、快速（高性能）的 web 框架，使用基于类型提示的 Python 3.6 及更高版本。

 

关键特性:

快速：可与 NodeJS 和 Go 比肩的极高性能（归功于 Starlette 和 Pydantic）。最快的 Python web 框架之一。

高效编码：提高功能开发速度约 200％ 至 300％。

更少 bug：减少约 40％ 的人为（开发者）导致错误。

智能：极佳的编辑器支持。处处皆可自动补全，减少调试时间。

简单：设计的易于使用和学习，减少阅读文档时间。

简短：减少代码重复。通过不同的参数声明实现丰富功能。bug 更少。

健壮：生产可用级别的代码。以及自动生成的交互式文档。

标准化：基于 API 的相关开放标准并完全兼容：OpenAPI (以前被称为 Swagger) 和 JSON Schema。

 

官方文档：https://fastapi.tiangolo.com

源码地址： https://github.com/tiangolo/fastapi

 

安装

 

1.fastapi安装

假设你已经安装pip，那么可以直接使用pip命令进行安装：

pip install fastapi

 

你还需要一个 ASGI 服务器，生产环境可以使用 Uvicorn 或者 Hypercorn。

 

2.开发服务器安装

pip install uvicorn

 

示例

 

1.创建

 

创建一个 main.py 文件并写入以下内容:

from fastapi import FastAPI

app = FastAPI()


@app.get("/")
def read_root():
    return {"Hello": "World"}


@app.get("/items/{item_id}")
def read_item(item_id: int, q: str = None):
    return {"item_id": item_id, "q": q}

或者使用 async def

from fastapi import FastAPI

app = FastAPI()


@app.get("/")
async def read_root():
    return {"Hello": "World"}


@app.get("/items/{item_id}")
async def read_item(item_id: int, q: str = None):
    return {"item_id": item_id, "q": q}

2.运行

通过以下命令运行服务器：

uvicorn main:app --reload

关于 uvicorn main:app --reload 命令

 

uvicorn main:app 命令含义如下:

 

main：main.py 文件（一个 Python "模块"）。

app：在 main.py 文件中通过 app = FastAPI() 创建的对象。

--reload：让服务器在更新代码后重新启动。仅在开发时使用该选项。

 

运行服务器成功会出现以下信息：

INFO: Uvicorn running on http://127.0.0.1:8000 (Press CTRL+C to quit)INFO: Started reloader process [28720]INFO: Started server process [28722]INFO: Waiting for application startup.INFO: Application startup complete.

检查

 

使用浏览器访问 http://127.0.0.1:8000/items/5?q=somequery。

你将会看到如下 JSON 响应：

{"item_id": 5, "q": "somequery"}

 

你已经创建了一个具有以下功能的 API：

 

• 通过 路径 / 和 /items/{item_id} 接受 HTTP 请求。

• 以上 路径 都接受 GET 操作（也被称为 HTTP 方法）。

• /items/{item_id} 路径 有一个 路径参数 item_id 并且应该为 int 类型。

• /items/{item_id} 路径 有一个可选的 str 类型的 查询参数 q。

 

api文档使用

 

 

1.交互式文档：

 

现在访问 http://127.0.0.1:8000/docs

你会看到自动生成的交互式 API 文档（由 SwaggerUI生成）:

 

2.备选 API 文档

 

访问 http://127.0.0.1:8000/redoc。

你会看到另一个自动生成的文档（由 ReDoc）生成：