FastAPI学习—FastAPI初识及参数传递使用—day03

关注

原创最新推荐文章于 2026-08-13 10:33:07 发布 2.8k 阅读 AI 写同款· GEO 优化 ›

【Python百日进阶-Web开发-FastAPI】Day801 - FastAPI是什么文章目录一、官网二、FastAPI是什么三、FastAPI特性3.1 基于开放标准3.2 自动生成文档3.3 更主流的 Python3.4 编辑器支持3.5 简洁3.6 验证3.7 安全性及身份验证¶3.8 依赖注入3.9 无限制"插件"3.10 测试四、Starlette 特性五、Pydantic 特性六、Python 类型提示简介6.1 动机6.1.1 简单示例6.1.2 修改示例6.1.3 添加类型6.2 更多动机6.3 声明类型6.3.1 简单类型6.3.2 嵌套类型6.3.2.1 列表6.3.2. 阅读详情

from fastapi import FastAPI, Query
from enum import Enum
from typing import Optional
from pydantic import BaseModel, Field


app = FastAPI()


@app.get("/")
def index():
    return "Hello World!"


"""
终端启动: 
1. uvicorn 模块名:模块中的app名 --reload   默认是127.0.0.1:8000
例：uvicorn main:app --reload
2. 设置ip和端口：uvicorn 模块名:模块中的app名 --reload --host=ip地址 --port=端口号
例：uvicorn 01:app --reload --host=0.0.0.0 --port=8080
"""


# 1. 路径参数
# 普通路径参数
# @app.get("/book/{book_id}/")
# def book_detail(book_id):
#     return {"book_id": book_id}


# 路径参数指定类型
@app.get("/book/{book_id}/")
def book_detail(book_id: int):
    return {"book_id": book_id}


# 路径参数设置枚举值类
class GenderNum(str, Enum):
    male = "male"
    female = "female"


# 参数设置枚举值
@app.get("/gender/{gender_name}/")
def gender(gender_name: GenderNum):
    return {"gender_name": gender_name}


# 2. 查询参数
# Optional：可选参数
# 可以使Optional中指定的类型，也可以是None类型
# 如果不传会报错，需要设置等于None，这样就可以不传
# @app.get("/search/")
# def search(q: Optional[str] = None):
#     return {"msg": "查询参数为{}".format(q)}


# 查询参数验证
# 不传默认为None
# @app.get("/search/")
# def search(q: str = Query(None, max_length=5)):
#     return {"msg": "查询参数为{}".format(q)}


# 验证必传, 不传会报错
@app.get("/search/")
def search(q: str = Query(..., max_length=5)):
    return {"msg": "查询参数为{}".format(q)}


# 3. 表单参数
# 设置表单请求体参数验证模型
class ArticleModel(BaseModel):
    title: str
    author: str
    content: str = None  # 如果没有传入这个参数，则默认为None
    description: str = Field(max_length=5)  # 限制最大长度


@app.post("/article/")
def add_article(article: ArticleModel):
    print(article)
    return {"article": article}