当前位置:   article > 正文

FastAPI:Python打造高效API的终极武器_fastapi八卦文

fastapi八卦文

在Python的世界里,如果你想要一个既快速又现代的方式来构建API,那么FastAPI可能是你的首选。这个库基于Starlette(用于Web编程)和Pydantic(用于数据验证),专门为速度和易用性设计。

image-20240429143040552

什么是FastAPI?

FastAPI 是一个用于构建API的现代、快速(高性能)框架,使用Python 3.6及以上版本,基于标准Python类型提示。它允许开发者使用Python的类型提示来声明请求和响应的数据模型,从而使得API具有自动生成的文档(Swagger UI),并支持数据验证和序列化。

核心特性:
  1. 快速:FastAPI框架非常快。其性能可与NodeJS和Go相媲美,主要得益于Starlette(用于Web微服务的工具集)和Pydantic(数据验证库)。
  2. 简单易用:设计目的是易于使用和学习,减少可能的错误。
  3. 自动生成文档:使用Swagger和ReDoc,FastAPI会自动为你生成交互式API文档。

FastAPI 的原理

FastAPI 使用 Python 的类型提示增强其性能和错误处理能力。当你创建一个API函数时,你可以给每个函数参数添加类型提示,FastAPI 会使用这些信息来执行请求参数的验证和序列化。

快速入门示例

步骤 1:安装FastAPI和Uvicorn

首先,我们需要安装FastAPI框架和Uvicorn,一个光速ASGI服务器,用于运行我们的应用。

pip install fastapi uvicorn
  • 1
步骤 2:创建一个基本的API

接下来,我们写一个简单的应用来展示FastAPI的基础功能,将代码保存为example.py。

from fastapi import FastAPI

app = FastAPI()

@app.get("/")
async def read_root():
    return {"Hello": "World"}
  • 1
  • 2
  • 3
  • 4
  • 5
  • 6
  • 7
步骤 3:运行服务器

运行上面的应用非常简单,只需要在命令行中执行以下命令:

uvicorn example:app --reload
  • 1

这条命令会启动服务器,并且每当你修改代码后,服务器会自动重新加载。

步骤 4:测试API

打开你的浏览器或者使用工具如Postman,访问 http://127.0.0.1:8000/,你将看到像这样的响应:

image-20240429115243099

进阶示例

from fastapi import FastAPI
from pydantic import BaseModel
from typing import List

app = FastAPI()

class Book(BaseModel):
    title: str
    author: str
    price: float
    in_stock: int

# 初始化books_db,确保每个条目都是Book对象
books_db: List[Book] = [
    Book(title="西游记", author="吴承恩", price=100.0, in_stock=10),
    Book(title="三国演义", author="罗贯中", price=120.0, in_stock=15),
    Book(title="水浒传", author="施耐庵", price=110.0, in_stock=5),
    Book(title="红楼梦", author="曹雪芹", price=130.0, in_stock=8)
]

@app.post("/books/")
async def add_book(book: Book):
    books_db.append(book)
    return {"msg": "Book added successfully", "book": book}

@app.get("/books/", response_model=List[Book])
async def get_books():
    return books_db
  • 1
  • 2
  • 3
  • 4
  • 5
  • 6
  • 7
  • 8
  • 9
  • 10
  • 11
  • 12
  • 13
  • 14
  • 15
  • 16
  • 17
  • 18
  • 19
  • 20
  • 21
  • 22
  • 23
  • 24
  • 25
  • 26
  • 27
  • 28

执行步骤

  1. 保存上述代码到一个名为example.py的文件中。

  2. 在你的开发环境中安装FastAPI和uvicorn:

    pip install fastapi uvicorn
    
    • 1
  3. 在命令行中运行下面的命令来启动服务器:

    uvicorn example:app --reload
    
    • 1
  4. 使用浏览器或API测试工具(如Postman)来发送请求:

    • 发送POST请求到http://127.0.0.1:8000/books/以添加新书。
    • 发送GET请求到http://127.0.0.1:8000/books/以查看所有书籍。

执行效果

image-20240429142128405

FastAPI 的官方文档是学习资源的宝库,提供了详尽的指南和API参考。

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

FastAPI GitHub:https://github.com/tiangolo/fastapi

FastAPI提供了一个强大而灵活的方式来构建API,其性能优异,自动化文档和数据验证功能可以大大加快开发速度。适合需要快速迭代和部署的现代Web应用。

希望这篇文章能帮助你了解FastAPI的基本用法和构建高效API的能力。

声明:本文内容由网友自发贡献,不代表【wpsshop博客】立场,版权归原作者所有,本站不承担相应法律责任。如您发现有侵权的内容,请联系我们。转载请注明出处:https://www.wpsshop.cn/w/煮酒与君饮/article/detail/887782
推荐阅读
相关标签
  

闽ICP备14008679号