使用FastAPI构建高效Python Web应用程序的详细教学

青旅半醒 2024-03-22 14:55 67阅读 0赞

FastAPI是一个快速（快于Flask和Django）且现代的Python Web框架，它使用Python 3.6+的新特性，如类型提示和异步/await语法，以提供高效的API构建体验。本文将介绍如何使用FastAPI构建高效Python Web应用程序。

#### 步骤1：安装FastAPI和uvicorn ####

在开始使用FastAPI之前，需要安装FastAPI和uvicorn。可以使用以下命令在终端中安装它们：

pip install fastapi
    pip install uvicorn

#### 步骤2：创建FastAPI应用程序 ####

创建一个名为main.py的文件，并在其中编写以下代码：

from fastapi import FastAPI
    
    app = FastAPI()
    
    @app.get("/")
    async def root():
        return {
        "message": "Hello World"}

在上面的代码中，我们首先导入FastAPI类，然后创建一个名为app的FastAPI实例。接下来，我们使用@app.get()装饰器将根路由/与root()函数关联起来。最后，我们在root()函数中返回一个JSON响应。

#### 步骤3：运行FastAPI应用程序 ####

要运行FastAPI应用程序，请在终端中使用以下命令：

uvicorn main:app --reload

在上面的命令中，我们使用uvicorn命令来运行FastAPI应用程序。main:app参数告诉uvicorn要运行名为main.py的文件中的app实例。–reload参数使uvicorn在代码更改时自动重新加载应用程序。

#### 步骤4：测试FastAPI应用程序 ####

现在，我们可以在浏览器中访问http://localhost:8000/，应该会看到以下JSON响应：

{
        "message": "Hello World"}

#### 步骤5：添加路由和请求体 ####

现在，我们将添加一个新的路由和一个带有请求体的路由。在main.py文件中添加以下代码：

from fastapi import FastAPI
    
    app = FastAPI()
    
    @app.get("/")
    async def root():
        return {
        "message": "Hello World"}
    
    @app.get("/items/{item_id}")
    async def read_item(item_id: int, q: str = None):
        return {
        "item_id": item_id, "q": q}
    
    @app.post("/items/")
    async def create_item(item: Item):
        return item

在上面的代码中，我们添加了两个新的路由。第一个路由是/items/\{item\_id\}，它接受一个名为item\_id的路径参数和一个名为q的查询参数。第二个路由是/items/，它接受一个名为item的请求体。

#### 步骤6：定义请求体模型 ####

在上面的代码中，我们使用了一个名为Item的请求体模型。我们需要在代码中定义它。在main.py文件中添加以下代码：

from fastapi import FastAPI
    from pydantic import BaseModel
    
    app = FastAPI()
    
    class Item(BaseModel):
        name: str
        price: float
        is_offer: bool = None
    
    @app.get("/")
    async def root():
        return {
        "message": "Hello World"}
    
    @app.get("/items/{item_id}")
    async def read_item(item_id: int, q: str = None):
        return {
        "item_id": item_id, "q": q}
    
    @app.post("/items/")
    async def create_item(item: Item):
        return item

在上面的代码中，我们使用了一个名为BaseModel的pydantic类来定义Item模型。Item模型具有三个属性：name，price和is\_offer。is\_offer属性是可选的，因为我们将其设置为None。

#### 步骤7：测试新的路由和请求体 ####

现在，我们可以在浏览器中访问http://localhost:8000/items/1?q=test，应该会看到以下JSON响应：

{
        "item_id": 1, "q": "test"}

我们还可以使用curl命令测试POST路由：

curl -X POST "http://localhost:8000/items/" -H "accept: application/json" -H "Content-Type: application/json" -d "{\"name\":\"Item Name\",\"price\":9.99}"

应该会看到以下JSON响应：

{
        "name": "Item Name", "price": 9.99, "is_offer": null}

结论

FastAPI是一个快速且现代的Python Web框架，它使用Python 3.6+的新特性，如类型提示和异步/await语法，以提供高效的API构建体验。在本文中，我们介绍了如何使用FastAPI构建高效Python Web应用程序，并添加了路由和请求体。希望这篇文章对你有所帮助！