探索FastAPI:不仅仅是一个Python Web框架,更是助力开发者高效构建现代化RESTful API服务的神器——从环境搭建到CRUD应用实战全面解析

简介: 【8月更文挑战第31天】FastAPI 是一个基于 Python 3.6+ 类型提示标准的现代 Web 框架,以其高性能、易用性和现代化设计而备受青睐。本文通过示例介绍了 FastAPI 的优势及其在构建高效 Web 应用中的强大功能。首先,通过安装 FastAPI 和 Uvicorn 并创建简单的“Hello, World!”应用入门;接着展示了如何处理路径参数和查询参数,并利用类型提示进行数据验证和转换。

探索FastAPI:Python的下一代Web框架

随着互联网技术的发展,Web应用的需求日益增长,对框架的要求也越来越高。FastAPI 作为一种新兴的 Python Web 框架,凭借其高性能、易用性及现代化的设计理念,正在成为越来越多开发者的首选。本文旨在探讨 FastAPI 的优势所在,并通过实际示例展示其在构建高效 Web 应用方面的强大能力。

FastAPI 是一个用于构建 API 的现代 Web 框架,它基于 Python 3.6+ 的类型提示标准,充分利用了异步编程的优势,使得开发者能够快速构建高性能的 Web 服务。FastAPI 不仅支持异步请求处理,还提供了内置的数据验证和文档生成功能,极大地提升了开发效率和代码质量。

首先,安装 FastAPI 和 Uvicorn(一个 ASGI 兼容的服务器):

pip install fastapi uvicorn

创建一个新的 FastAPI 应用,通常我们会从一个简单的 “Hello, World!” 示例开始:

# main.py
from fastapi import FastAPI

app = FastAPI()

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

运行应用:

uvicorn main:app --reload

访问 http://127.0.0.1:8000,你应该能看到 { "Hello": "World" } 的响应。

接下来,让我们看看 FastAPI 如何处理路径参数和查询参数。在 FastAPI 中,路径参数和查询参数可以通过路径操作函数的参数直接获取:

# main.py
from fastapi import FastAPI

app = FastAPI()

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

在这个例子中,item_id 是路径参数,q 是可选的查询参数。访问 http://127.0.0.1:8000/items/1?q=somequery,可以看到 { "item_id": 1, "q": "somequery" } 的响应。

FastAPI 还支持类型提示,这使得框架能够自动进行数据验证和转换。例如,通过指定 item_id 的类型为 int,FastAPI 会确保传入的值是一个整数,否则会返回错误。

除了路径参数和查询参数,FastAPI 还提供了对请求体的支持。下面是一个简单的例子,展示了如何接收 JSON 请求体:

# main.py
from fastapi import FastAPI
from pydantic import BaseModel

app = FastAPI()

class Item(BaseModel):
    name: str
    description: str | None = None
    price: float
    tax: float | None = None

@app.post("/items/")
async def create_item(item: Item):
    return item

在这个例子中,我们定义了一个名为 Item 的 Pydantic 模型,它包含了 namedescriptionpricetax 字段。当向 /items/ 发送 POST 请求时,FastAPI 会自动验证请求体是否符合 Item 模型的定义,并将其转换为 Python 对象。

FastAPI 还提供了自动文档生成的功能,这是其一大亮点。只需运行应用并访问 http://127.0.0.1:8000/docshttp://127.0.0.1:8000/redoc,就可以看到一个交互式的 API 文档页面。这个页面不仅展示了所有可用的 API 接口,还允许直接在浏览器中测试它们。

为了进一步展示 FastAPI 的灵活性,我们来构建一个简单的 CRUD(创建、读取、更新、删除)应用。首先,定义一个数据库模型:

# models.py
from pydantic import BaseModel

class ItemBase(BaseModel):
    name: str
    description: str | None = None

class ItemCreate(ItemBase):
    pass

class Item(ItemBase):
    id: int
    owner_id: int

    class Config:
        orm_mode = True

接下来,创建一个简单的 CRUD 操作:

# crud.py
from typing import List, Optional
from sqlalchemy.orm import Session
from models import Item

def get_items(db: Session, skip: int = 0, limit: int = 100):
    return db.query(Item).offset(skip).limit(limit).all()

def get_item(db: Session, item_id: int):
    return db.query(Item).filter(Item.id == item_id).first()

def create_item(db: Session, item: ItemCreate):
    db_item = Item(**item.dict())
    db.add(db_item)
    db.commit()
    db.refresh(db_item)
    return db_item

def update_item(db: Session, item_id: int, item: ItemCreate):
    db_item = db.query(Item).filter(Item.id == item_id).first()
    if db_item:
        db_item.name = item.name
        db_item.description = item.description
        db.commit()
        db.refresh(db_item)
    return db_item

def delete_item(db: Session, item_id: int):
    db_item = db.query(Item).filter(Item.id == item_id).first()
    if db_item:
        db.delete(db_item)
        db.commit()
    return db_item

main.py 中,引入这些 CRUD 操作,并创建对应的路由:

# main.py
from fastapi import FastAPI, Depends
from sqlalchemy.orm import Session
from database import SessionLocal, engine
from crud import get_items, get_item, create_item, update_item, delete_item
from models import Item, ItemCreate

app = FastAPI()

# Dependency
def get_db():
    db = SessionLocal()
    try:
        yield db
    finally:
        db.close()

@app.post("/items/", response_model=Item)
def create_new_item(item: ItemCreate, db: Session = Depends(get_db)):
    return create_item(db=db, item=item)

@app.get("/items/", response_model=List[Item])
def read_items(skip: int = 0, limit: int = 100, db: Session = Depends(get_db)):
    items = get_items(db, skip=skip, limit=limit)
    return items

@app.get("/items/{item_id}", response_model=Optional[Item])
def read_item(item_id: int, db: Session = Depends(get_db)):
    return get_item(db, item_id=item_id)

@app.put("/items/{item_id}", response_model=Optional[Item])
def update_existing_item(item_id: int, item: ItemCreate, db: Session = Depends(get_db)):
    return update_item(db, item_id=item_id, item=item)

@app.delete("/items/{item_id}", response_model=Optional[Item])
def delete_item(item_id: int, db: Session = Depends(get_db)):
    return delete_item(db, item_id=item_id)

通过以上示例,我们展示了 FastAPI 在处理路径参数、查询参数、请求体以及 CRUD 操作方面的强大功能。FastAPI 的类型提示、自动数据验证和文档生成功能,使得开发者能够专注于业务逻辑的实现,而不必担心繁琐的框架配置。希望本文提供的代码示例和实践指南能够帮助你在实际项目中更好地应用 FastAPI 框架,构建出高效且功能完备的 Web 应用。

相关文章
|
10月前
|
JSON 安全 Java
API 一键转换 MCP 服务!Higress 助今日投资快速上线 MCP 市场
今日投资的技术负责人介绍了如何通过Higress MCP 市场完善的解决方案,快捷地将丰富的金融数据 API 转化为 MCP 工具,帮助用户通过 MCP 的方式非常轻松地调用专业金融数据,自由快速地构建自己的金融大模型应用。
1177 24
|
8月前
|
存储 前端开发 Java
【JAVA】Java 项目实战之 Java Web 在线商城项目开发实战指南
本文介绍基于Java Web的在线商城技术方案与实现,涵盖三层架构设计、MySQL数据库建模及核心功能开发。通过Spring MVC + MyBatis + Thymeleaf实现商品展示、购物车等模块,提供完整代码示例,助力掌握Java Web项目实战技能。(238字)
940 0
|
9月前
|
XML JSON API
识别这些API接口定义(http,https,api,RPC,webservice,Restful api ,OpenAPI)
本内容介绍了API相关的术语分类,包括传输协议(HTTP/HTTPS)、接口风格(RESTful、WebService、RPC)及开放程度(API、OpenAPI),帮助理解各类API的特点与应用场景。
|
11月前
|
缓存 安全 API
RESTful与GraphQL:电商API接口设计的技术细节与适用场景
本文对比了RESTful与GraphQL这两种主流电商API接口设计方案。RESTful通过资源与HTTP方法定义操作,简单直观但可能引发过度或欠获取数据问题;GraphQL允许客户端精确指定所需字段,提高灵活性和传输效率,但面临深度查询攻击等安全挑战。从性能、灵活性、安全性及适用场景多维度分析,RESTful适合资源导向场景,GraphQL则适用于复杂数据需求。实际开发中需根据业务特点选择合适方案,或结合两者优势,以优化用户体验与系统性能。
|
8月前
|
存储 JavaScript 安全
Web渗透-XSS漏洞深入及xss-labs靶场实战
XSS(跨站脚本攻击)是常见的Web安全漏洞,通过在网页中注入恶意脚本,窃取用户信息或执行非法操作。本文介绍其原理、分类(反射型、存储型、DOM型)、测试方法及xss-labs靶场实战案例,帮助理解与防御XSS攻击。
2490 1
Web渗透-XSS漏洞深入及xss-labs靶场实战
|
8月前
|
安全 Linux PHP
Web渗透-命令执行漏洞-及常见靶场检测实战
命令执行漏洞(RCE)指应用程序调用系统命令时,用户可控制输入参数,导致恶意命令被拼接执行,从而危害系统安全。常见于PHP的system、exec等函数。攻击者可通过命令连接符在目标系统上执行任意命令,造成数据泄露或服务瘫痪。漏洞成因包括代码层过滤不严、第三方组件缺陷等。可通过参数过滤、最小权限运行等方式防御。本文还介绍了绕过方式、靶场测试及复现过程。
1715 0
|
9月前
|
人工智能 算法 API
国产化用于单导联和六导联的心电算法及API服务
随着智能设备普及,心电图功能逐渐应用于智能手表、体脂仪等设备。苏州唯理推出单导联及6导联心电算法API服务,由AI驱动,1分钟内快速评估心律失常、房颤、早搏等问题,已广泛用于医疗设备及三甲医院。其算法还可评估压力、疲劳、情绪状态,筛查效率远超进口设备。唯理率先实现国产医疗级心电芯片,支持快速集成与私有化部署,适用于多种智能硬件。
|
11月前
|
JSON 编解码 API
Go语言网络编程:使用 net/http 构建 RESTful API
本章介绍如何使用 Go 语言的 `net/http` 标准库构建 RESTful API。内容涵盖 RESTful API 的基本概念及规范,包括 GET、POST、PUT 和 DELETE 方法的实现。通过定义用户数据结构和模拟数据库,逐步实现获取用户列表、创建用户、更新用户、删除用户的 HTTP 路由处理函数。同时提供辅助函数用于路径参数解析,并展示如何设置路由器启动服务。最后通过 curl 或 Postman 测试接口功能。章节总结了路由分发、JSON 编解码、方法区分、并发安全管理和路径参数解析等关键点,为更复杂需求推荐第三方框架如 Gin、Echo 和 Chi。
|
10月前
|
缓存 边缘计算 前端开发
从业务需求到技术栈:电商API选型RESTful还是GraphQL?这5个维度帮你决策
在数字经济时代,电商平台的竞争已延伸至用户体验与系统效能。作为连接前后端及各类服务的核心,API接口的架构设计至关重要。本文对比RESTful与GraphQL两大主流方案,从电商场景出发,分析两者的技术特性、适用场景与选型逻辑,帮助开发者根据业务需求做出最优选择。