1.FastAPI介绍

---

fastapi.png

一、 Fastapi是什么

FastAPI 框架，高性能，易于学习，高效编码，生产可用

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

二、Fastapi特点

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

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

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

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

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

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

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

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

• 根据对某个构建线上应用的内部开发团队所进行的测试估算得出。

三、 使用简介

3.1. 依赖

版本 Python 3.6 +
Fastapi 主要依赖一下两个库：

• Starlette 主要负责web部分
• Pydantic 负责数据部分

3.2. 安装

# [fastapi v0.74.0]
pip install fastapi               
# 还需要一个ASGI [uvicorn v0.17.5]
pip install uvicorn[standart]     

3.3. 示例

3.3.1创建 main.py 文件

from fastapi import FastAPI
from typing import Optional 


app = FastAPI()



@app.get("/")
def read_root():
    return {"data": "hello world"}



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

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

1. 通过 路径 / 和 /items/{item_id} 接受 HTTP 请求。
2. 以上 路径 都接受 GET 操作（也被称为 HTTP 方法）。
3. /items/{item_id} 路径 有一个 路径参数 item_id 并且应该为 int 类型。
4. /items/{item_id} 路径 有一个可选的 str 类型的 查询参数 q。

3.3.2 运行 main.py 文件

# main: 程序文件的文件名
# app:  主程序入口函数
# reload: 让服务器在更新代码后重新启动。仅在开发时使用该选项

$ uvicorn main:app --reload
       
INFO:     Will watch for changes in these directories: ['/workspace/fastapitest']
INFO:     Uvicorn running on http://127.0.0.1:8000 (Press CTRL+C to quit)
INFO:     Started reloader process [62315] using statreload
INFO:     Started server process [62317]
INFO:     Waiting for application startup.
INFO:     Application startup complete.

3.3.3 检查

使用浏览器访问 http://127.0.0.1:8000/items/7788?q=somestr

# 浏览器将会显示
{"item_id":7788,"q":"somestr"}

3.3.4 交互API文档 (原swagger)

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

你会看到自动生成的交互式 API 文档（由 Swagger UI生成）：

docs.png

3.3.5 可选API文档 redoc

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

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

redoc.png