1. Python技术站首页
  2. Web开发
  3. Flask

FastApi如何快速构建一个web项目的实现

• Flask

FastAPI 是一个基于 asyncio 和 pydantic 的现代化 Web 框架，提供了快速开发高性能且易于扩展的 API 工具。适合用于构建现代高性能 Web 服务 API、机器学习应用等等场景。下面将详细讲解如何使用FastAPI快速构建一个Web项目的实现。

一. 安装FastAPI

FastAPI可以通过pip安装，安装FastAPI的同时也会自动安装uvicorn，这是一个一款轻量级的Python ASGI服务器，用于部署FastAPI应用程序。

pip install fastapi

二. 创建一个新项目

使用FastAPI创建一个新项目非常方便，只需要创建一个文件并且引入FastAPI即可。下面是一个最简单的例子： 

from fastapi import FastAPI

app = FastAPI()

@app.get("/")
async def index():
    return {"message": "Hello World"}
  • 引入FastAPI并创建一个FastAPI实例；
  • 使用装饰器@app.get()指定路由路径和HTTP请求方法；
  • 定义一个异步函数index()，对请求进行处理；
  • 发回一个JSON格式的响应。

使用命令uvicorn main:app --reload运行程序，访问http://127.0.0.1:8000即可看到运行结果。

三. 添加路由

对于一个Web项目而言，路由非常重要。FastAPI提供了装饰器@app.route()和@app.get()，来指定支持的URL路由和HTTP请求方法。

from fastapi import FastAPI

app = FastAPI()

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

@app.get("/items/{id}")
async def read_item(id: int):
    return {"id": id, "name": "Sample Item"}

这里定义了两个路由：一个是/，一个是/items/{id}。后者中{id}是一个路由参数，使用int表示参数的类型是整数。在代码中接收到的参数将自动的转换为整数，如果参数类型不匹配会返回400错误。

四. 符合规范的请求体

在许多场景下，请求需要包含一些输入数据，比如，用户表单提交，或者发送到 Web 服务的 JSON 数据。在 FastAPI 中，已经可以通过包含参数来处理这样的输入数据，但是如果我们要发送一个大型的JSON数据，可以使用pydantic.BaseModel。

from typing import Optional
from fastapi import FastAPI
from pydantic import BaseModel

app = FastAPI()

class Item(BaseModel):
    name: str
    price: float
    is_offer: Optional[bool] = None

@app.post("/items/")
async def create_item(item: Item):
    item_dict = item.dict()
    if item.is_offer:
        item_dict.update({"message": "Special offer"})
    return item_dict

BaseModel是pydantic库提供的一个与FastAPI紧密集成的数据验证工具，可以用来定义API的输入和输出类型。在上面的示例中，我们使用pydantic.BaseModel定义了一个数据模型Item，其中包含名称、价格和是否优惠等字段，is_offer是个可选的布尔型参数。app.post()用来指定HTTP请求的方法为POST。

五. 添加文档

FastAPI自带OpenAPI和JSON Schema支持，可以自动为API生成详细可读的文档。

from typing import Optional
from fastapi import FastAPI
from pydantic import BaseModel

app = FastAPI()

class Item(BaseModel):
    name: str
    price: float
    is_offer: Optional[bool] = None

@app.post("/items/")
async def create_item(item: Item):
    item_dict = item.dict()
    if item.is_offer:
        item_dict.update({"message": "Special offer"})
    return item_dict

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

@app.get("/items/{id}")
async def read_item(id: int):
    return {"id": id, "name": "Sample Item"}

# 1. 添加文档
@app.get("/docs")
async def get_docs():
    return {"message": "Docs"}

# 2. 添加API版本
@app.get("/v1/items/{id}")
async def read_item_v1(id: int):
    return {"id": id, "name": "Sample Item"}

在上面的代码里，我们针对/docs路径定义一个路由，直接返回文档。 FastAPI 的自动文档工具将扫描路由映射并生成相应的文档页面。

六. 添加中间件

中间件通常是一些可以在 HTTP 请求处理过程中执行的拦截器。 FastAPI 提供了一个很方便的中间件系统，我们只需要通过 FastAPI 的 API 即可添加中间件。

from fastapi import FastAPI, Request

app = FastAPI()

# 1. 添加中间件
@app.middleware("http")
async def add_custom_header(request: Request, call_next):
    response = await call_next(request)
    response.headers["X-Custom-Header"] = "demo"
    return response

# 2. 添加路由
@app.get("/")
async def index():
    return {"message": "Hello World"}

@app.get("/items/{id}")
async def read_item(id: int):
    return {"id": id, "name": "Sample Item"}

第一步，我们定义了一个中间件函数add_custom_header()，此中间件会在处理 HTTP 请求时拦截请求和响应。其中call_next()则是调用下一个中间件或路由处理程序，这个函数必须在中间件之后使用。在函数中，我们向 HTTP 响应 header 添加了一个自定义的 X-Custom-Header 头部。

第二步，我们定义了两个路由，其中一个是根路径，一个是一个动态路径。

七. 实例一

接下来，我们使用这个框架来完成一个表单提交的应用。

from fastapi import FastAPI, Request, Form
from fastapi.responses import HTMLResponse

app = FastAPI()

# 中间件，拦截请求和响应
@app.middleware("http")
async def add_custom_header(request: Request, call_next):
    response = await call_next(request)
    response.headers["X-Custom-Header"] = "demo"
    return response

# 返回Home页面
@app.get("/", response_class=HTMLResponse)
async def home():
    html_content = """
    <html>
        <head>
            <title>FastAPI Form</title>
        </head>
        <body>
            <form action="/form" method="post">
                <label>Name: <input type="text" name="name"></label>
                <br>
                <label>Email: <input type="email" name="email"></label>
                <br>
                <input type="submit" value="Submit">
            </form>
        </body>
    </html>
    """
    return html_content

# 表单提交路由
@app.post("/form")
async def submit_form(name: str = Form(...), email: str = Form(...)):
    return {"message": f"{name} Submitted successfully with {email}"}

使用命令uvicorn main:app --reload启动程序，访问 http://localhost:8000 即可看到页面。填写表单后点击提交，数据将提交到路由/form进行处理，并返回一个JSON数据，展示了提交的名字和电子邮件地址。

八. 实例二

下面这个例子是一个计算器应用，包含两个接口：加法和减法。

from fastapi import FastAPI
from pydantic import BaseModel

app = FastAPI()

class CalcRequest(BaseModel):
    first: int
    second: int

class CalcResult(BaseModel):
    result: int

# 加法接口
@app.post("/add", response_model=CalcResult)
async def add(req: CalcRequest):
    return CalcResult(result=req.first + req.second)

# 减法接口
@app.post("/sub", response_model=CalcResult)
async def subtract(req: CalcRequest):
    return CalcResult(result=req.first - req.second)

CalcRequest类是输入数据的数据类型，它定义了两个整数数据first和second。CalcResult是输出数据的数据类型，它只包含一个字段result，表示计算结果。

两个路由都使用了@app.post()装饰器，DataFrame中定义的数据模型作为第一个参数进行传递。输出模型从CalcResult中指定，以确保输出结果合规。

使用命令uvicorn main:app --reload运行程序，访问 http://127.0.0.1:8000/add 和 http://127.0.0.1:8000/sub 即可看到运行结果。

以上就是关于使用FastAPI快速构建Web项目的实现过程。FastAPI提供了便捷快速的开发API的方式，支持自动文档和JSON schema生成等，可以极大提高开发效率，推荐大家使用。

本站文章如无特殊说明，均为本站原创，如若转载，请注明出处：FastApi如何快速构建一个web项目的实现 - Python技术站

赞 (0)
0 0 打赏 微信扫一扫 微信扫一扫 支付宝扫一扫 支付宝扫一扫
上一篇 2023年5月16日
下一篇 2023年5月16日

相关文章

  • Python库 Bokeh 数据可视化实用指南

    下面我为您详细讲解“Python库 Bokeh 数据可视化实用指南”的完整攻略。 Python库 Bokeh 数据可视化实用指南 什么是 Bokeh？ Bokeh是一个用于Python编程语言的交互式数据可视化库。它可以帮助用户通过美观、灵活的图表来呈现大数据集、实时流数据以及复杂的统计数据。Bokeh提供了多种绘图选项，包括线状图、条形图、散点图、热力图等…

    Flask 2023年5月16日
    00

  • python flask项目打包成docker镜像发布的过程

    下面我来分享一下Python Flask项目打包为Docker镜像并发布的完整攻略。 环境准备 在开始之前，你需要确保已经安装好以下工具： Docker Docker-Compose Python Flask Git 如果你还没有安装，可以参考以下步骤进行安装： 安装Docker和Docker-Compose。可以访问Docker官网并按照官网的指引进行安装…

    Flask 2023年5月16日
    00

  • Python动态配置管理Dynaconf的实现示例详解

    针对“Python动态配置管理Dynaconf的实现示例详解”这个话题，我们可以分成以下几个部分进行讲解： 什么是Dynaconf Dynaconf的使用方法 示例一：使用Dynaconf管理Flask应用的配置 示例二：使用Dynaconf和Docker容器管理Django应用的配置 1. 什么是Dynaconf Dynaconf是一个Python库，旨在…

    Flask 2023年5月16日
    00

  • Flask带参URL传值的实现方法

    下面是完整的攻略，包含两个示例说明。 Flask带参URL传值的实现方法 在基于Flask框架构建Web应用程序的开发中，要实现将参数传递给URL的功能，Flask提供了多种实现方法。下面分别对这些方法进行详细的讲解。 方法1：基于URL路径传递参数 这是一种常见的URL传递参数的方式，在URL路径中添加参数，可以通过Flask提供的URL规则，解析出参数并…

    Flask 2023年5月16日
    00

  • Flask框架WTForm表单用法示例

    接下来我将详细讲解Flask框架WTForm表单用法示例的完整攻略。 简介 在Flask web应用程序中，表单是收集用户数据的标准方式。为了使表单处理更加方便和安全，WTForms库提供了许多功能和检查方法。本攻略将演示如何使用Flask和WTForms创建表单，以及如何在视图函数中处理表单数据。 示例一：创建简单的表单 在这个示例中，我们将使用WTFor…

    Flask 2023年5月16日
    00

  • Python Flask前后端Ajax交互的方法示例

    这里是关于“Python Flask前后端Ajax交互的方法示例”的完整攻略： 1. 简介 Flask是一个轻量级的Web框架，常被用于快速构建Web应用程序。在Web应用程序中，我们经常需要使用Ajax技术来实现前后端数据交互。本文将介绍使用Flask框架实现前后端Ajax交互的方法。 2. 示例一：实现前后端Ajax交互 2.1 准备工作 首先，我们需要…

    Flask 2023年5月15日
    00

  • 一个基于flask的web应用诞生 组织结构调整（7）

    我来给你详细讲解一下。 “一个基于flask的web应用诞生 组织结构调整（7）”是一篇关于使用Flask框架搭建web应用的教程。其中，作者介绍了如何使用Flask框架来构建一个基础的web应用，并通过对项目的组织结构进行调整，使得代码更加清晰易懂，可维护性更高。 这篇教程主要包括以下内容： 创建Flask应用 通过使用Flask框架提供的API，可以快速…

    Flask 2023年5月15日
    00

  • 使用Python来编写HTTP服务器的超级指南

    使用Python编写HTTP服务器是一项强大的技能，它能够帮助你构建自己的web应用程序或者提供API访问。下面是一份完整的攻略来指导你如何使用Python编写HTTP服务器。 第一步：安装Python 要使用Python编写HTTP服务器，首先需要在计算机上安装Python。你可以从官网下载稳定的发行版，然后按照官网的步骤进行安装。你应该安装最新的稳定版本…

    Flask 2023年5月15日
    00
合作推广
合作推广
分享本页
返回顶部