python --version

pip install fastapi


from fastapi import FastAPI
import uvicorn

app = FastAPI()

@app.get('/')
def read_root():
    return {'message' : 'Hello FastAPI'}

uvicorn main:app --reload


# test_main.py
from fastapi.testclient import TestClient
from main import app

client = TestClient(app)

def test_read_root():
    response = client.get('/')
    assert response.status_code == 200
    assert response.json() == {'message' : 'Hello FastAPI'}

pytest

FROM python:3.9

WORKDIR /app

COPY requirements.txt .
RUN pip install --no-cache-dir -r requirements.txt

COPY . .

CMD ["uvicorn", "app.main:app", "--host", "0.0.0.0", "--port", "80"]


from fastapi import FastAPI
from typing import Union # 用于支持多种数据类型的参数注解

app = FastAPI() # 创建 FastAPI 实例

# 使用了 @app.get("/") 装饰器，定义一个 GET 请求的路由，路径为根路径 "/"
# 表示当用户通过 HTTP GET 请求访问根路径时，将执行 read_root 函数
# 函数返回一个包含 {"Hello": "World"} 的字典，这个字典会被 FastAPI 自动转换为 JSON 格式并返回给用户。    
@app.get('/') 
def read_root():
    return {'message' : 'Hello FastAPI'}

# 函数接受两个参数：
# item_id  是路径参数，指定为整数类型。
# q        是查询参数，指定为字符串类型或空（None）。允许在请求中不提供 q 参数。
@app.get('/items/{item_id}')
def read_item(item_id: int, q: Union[str, None] = None):
    return {'item_id': item_id, 'q': q}


from typing import Union
from fastapi import FastAPI
from pydantic import BaseModel

app = FastAPI()


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


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


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


@app.put("/items/{item_id}")
def update_item(item_id: int, item: Item):
    return {"item_name": item.name, "item_id": item_id}

@app.get("/items/")
def read_item(skip: int = 0, limit: int = 10):
    return {"skip": skip, "limit": limit}

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


from fastapi import FastAPI
from pydantic import BaseModel

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

app = FastAPI()

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


# 例如之前的
@app.get('/items/{item_id}')
def read_item(item_id: int, q: Union[str, None] = None):
    return {'item_id': item_id, 'q': q}


# 例如之前的
class Item(BaseModel):
    name: str
    price: float
    is_offer: bool = None 

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


from fastapi import FastAPI
from fastapi import Header,Cookie

app = FastAPI() 
@app.get('/items/')
def read_items(user_agent:str=Header(None),session_token:str=Cookie(None)):
    return {'user_agent': user_agent, 'session_token': session_token}


from fastapi import FastAPI
from fastapi import Header,Cookie
from fastapi.responses import RedirectResponse

app = FastAPI() 
@app.get('/items/')
def read_items(user_agent:str=Header(None),session_token:str=Cookie(None)):
    return {'user_agent': user_agent, 'session_token': session_token}

@app.get('/redirect/')
def redirect():
    return RedirectResponse(url='/items/')


from fastapi import FastAPI
from fastapi import HTTPException

app = FastAPI()

@app.get('/items/{item_id}')
def read_item(item_id:int):
  if item_id == 42:
    raise HTTPException(status_code=404,detail='item not found')
  return {'item_id': item_id}


from fastapi import FastAPI
from fastapi.reponses import JSONResponse

app = FastAPI()

@app.get('/items/{item_id}')
def read_item(item_id:int):
    headers={'X-Custom-Header':'custom-header-value'}
    content={'item_id':item_id}
    return JSONResponse(header=header,content=content)


from fastapi import FastAPI
from pydantic import BaseModel

app = FastAPI()

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

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

# 请求连接示例：
# curl -X POST "http://127.0.0.1:8000/items/" -H "accept: application/json" -H "Content-Type: application/json" -d '{"name":"Foo","price":35.5,"description":"A very nice Item","tax":3.5}'


from fastapi import Query
 
@app.get('/items/')
def read_item(item:Item,q:str=Query(...,max_length=10)):
    return {'item':item,'q':q}


from fastapi import FastAPI,Depends

app = FastAPI()

def common_parameters(q:str=None,skip:int=0,limit:int=10):
    return {'q':q,'skip':skip,'limit':limit}

@app.get('/items/')
async def read_item(commons:dict=Depends(common_parameters)):
    return commons


# -----同上------
from fastapi import FastAPI,Depends

app = FastAPI()

def common_parameters(q:str=None,skip:int=0,limit:int=10):
    return {'q':q,'skip':skip,'limit':limit}

@app.get('/items/')
async def read_item(commons:dict=Depends(common_parameters)):
    return commons

# -----后处理-----
async def after_request():
    # 这里可以执行一些后处理逻辑，比如记录日志
    pass

@app.get("/items/", response_model=dict) # esponse_model=dict 用于指定路由返回的响应数据的模型
async def read_items_after(request: dict = Depends(after_request)):
    return {"message": "Items returned successfully"}


from fastapi import Depends, FastAPI, HTTPException

app = FastAPI()

# 依赖项函数1
def common_parameters(q: str = None, skip: int = 0, limit: int = 10):
    return {"q": q, "skip": skip, "limit": limit}

# 依赖项函数2
def verify_token(token: str = Depends(common_parameters)):
    if token is None:
        raise HTTPException(status_code=400, detail="Token required")
    return token

# 路由操作函数
@app.get("/items/")
async def read_items(token: dict = Depends(verify_token)):
    return token


from fastapi import Depends, FastAPI, HTTPException
from typing import Optional
import asyncio

app = FastAPI()

# 异步依赖项函数
async def get_token():
    # 模拟异步操作
    await asyncio.sleep(2)
    return "fake-token"

# 异步路由操作函数
@app.get("/items/")
async def read_items(token: Optional[str] = Depends(get_token)):
    return {"token": token}

pip install python-multipart。


from fastapi import FastAPI, Form

app = FastAPI()

@app.post("/login/")
async def login(username: str = Form(), password: str = Form()):
    return {"username": username}


from pydantic import BaseModel, Field

class Item(BaseModel):
    name: str = Field(..., title="Item Name", max_length=100)
    description: str = Field(None, title="Item Description", max_length=255)
    price: float = Field(..., title="Item Price", gt=0)


from fastapi import FastAPI, Form

app = FastAPI()

# 路由操作函数
@app.post("/items/")
async def create_item(
    name: str = Form(...),
    description: str = Form(None),
    price: float = Form(..., gt=0),
):
    return {"name": name, "description": description, "price": price}


from fastapi import FastAPI, File, UploadFile

app = FastAPI()

# 路由操作函数
@app.post("/files/")
async def create_file(file: UploadFile = File(...)):
    return {"filename": file.filename}

部分	说明
http://	协议（HTTP）
127.0.0.1	服务器地址（本地）
:8000	端口号（FastAPI 默认端口）
/items/	路径（路由）
?	查询字符串开始
skip=1	参数1（跳过1条数据）
&	参数分隔符
limit=5	参数2（限制返回5条数据）

响应头信息（英文）	响应头信息（中文）	描述
Date	日期	响应生成的日期和时间。例如：Wed, 18 Apr 2024 12:00:00 GMT
Server	服务器	服务器软件的名称和版本。例如：Apache/2.4.1 (Unix)
Content-Type	内容类型	响应体的媒体类型（MIME类型），如text/html; charset=UTF-8, application/json等。
Content-Length	内容长度	响应体的大小，单位是字节。例如：3145
Content-Encoding	内容编码	响应体的压缩编码，如 gzip, deflate等。
Content-Language	内容语言	响应体的语言。例如：zh-CN
Content-Location	内容位置	响应体的 URI。例如：/index.html
Content-Range	内容范围	响应体的字节范围，用于分块传输。例如：bytes 0-999/8000
Cache-Control	缓存控制	控制响应的缓存行为, 如 no-cache 表示必须重新请求。
Connection	连接	管理连接的选项，如keep-alive或close，keep-alive 表示连接不会在传输后关闭。
Set-Cookie	设置 Cookie	设置客户端的 cookie。例如：sessionId=abc123; Path=/; Secure
Expires	过期时间	响应体的过期日期和时间。例如：Thu, 18 Apr 2024 12:00:00 GMT
Last-Modified	最后修改时间	资源最后被修改的日期和时间。例如：Wed, 18 Apr 2024 11:00:00 GMT
ETag	实体标签	资源的特定版本的标识符。例如："33a64df551425fcc55e6"
Location	位置	用于重定向的 URI。例如：/newresource
Pragma	实现特定的指令	包含实现特定的指令，如 no-cache。
WWW-Authenticate	认证信息	认证信息，通常用于HTTP认证。例如：Basic realm="Access to the site"
Accept-Ranges	接受范围	指定可接受的请求范围类型。例如：bytes
Age	经过时间	响应生成后经过的秒数，从原始服务器生成到代理服务器。例如：24
Allow	允许方法	列出资源允许的 HTTP 方法。例如：GET, POST，HEAD等
Vary	变化	告诉下游代理如何使用响应头信息来确定响应是否可以从缓存中获取。例如：Accept
Strict-Transport-Security	严格传输安全	指示浏览器仅通过 HTTPS 与服务器通信。例如：max-age=31536000; includeSubDomains
X-Frame-Options	框架选项	控制页面是否允许在框架中显示，防止点击劫持攻击。例如：SAMEORIGIN
X-Content-Type-Options	内容类型选项	指示浏览器不要尝试猜测资源的 MIME 类型。例如：nosniff
X-XSS-Protection	XSS保护	控制浏览器的 XSS 过滤和阻断。例如：1; mode=block
Public-Key-Pins	公钥固定	HTTP 头信息，用于HTTP公共密钥固定（HPKP），一种安全机制，用于防止中间人攻击。例如：pin-sha256="base64+primarykey"; pin-sha256="base64+backupkey"; max-age=expireTime

简介¶

安装¶

简单实例¶

项目结构建议¶

调试 FastAPI¶

部署准备¶

Fast API应用¶

FastAPI 交互式 API 文档¶

FastAPI 基本路由¶

查询参数路由¶

路径参数路由¶

FastAPI 请求和响应¶

请求体¶

响应体¶

重定向和状态码¶

自定义响应头¶

FastAPI Pydantic 模型¶

请求体验证¶

查询参数验证¶

FastAPI 路径操作依赖项¶

依赖项¶

预处理¶

后处理¶

多个依赖项的组合¶

异步依赖项¶

FastAPI 表单数据¶

声明表单数据模型¶

在路由中接收表单数据¶

处理文件上传¶

FastAPI 核心概念¶

HTTP 相关¶

消息结构¶

响应头¶

简介¶

安装¶

简单实例¶

项目结构建议¶

调试 FastAPI¶

部署准备¶

Fast API应用¶

FastAPI 交互式 API 文档¶

FastAPI 基本路由¶

查询参数路由¶

路径参数路由¶

FastAPI 请求和响应¶

请求体¶

响应体¶

请求头和 Cookie¶

重定向和状态码¶

自定义响应头¶

FastAPI Pydantic 模型¶

请求体验证¶

查询参数验证¶

FastAPI 路径操作依赖项¶

依赖项¶

预处理¶

后处理¶

多个依赖项的组合¶

异步依赖项¶

FastAPI 表单数据¶

声明表单数据模型¶

在路由中接收表单数据¶

处理文件上传¶

FastAPI 核心概念¶

HTTP 相关¶

消息结构¶

响应头¶