02 FastApi的路径参数

1> 在同一个项目中，可通过不同的路径访问不同的接口

from  fastapi import FastAPI

# 创建Fastapi实例
app = FastAPI()

@app.get("/path1") # 指明调用方法与调用路径
async def HelloWorld():
    # 实现内部逻辑
    return {'hello': "world"}

@app.get("/path2") # 指明调用方法与调用路径
async def HelloWorld1():
    # 实现内部逻辑
    return {'hello': "world"}

image.png

2> 可以在路径中申明参数 和变量 传递给函数，实现动态访问

Notes: 需用大括号在路径中标记

from  fastapi import FastAPI

# 创建Fastapi实例
app = FastAPI()

@app.get("/{item}") # 传入路径参数
async def HelloWorld(item):
    # 函数内部调用传入的参数
    return {'helloworld': item}

3> 可在接口函数内使用类型提示，指定传入的参数类型

from  fastapi import FastAPI

# 创建Fastapi实例
app = FastAPI()

@app.get("/{item}") # 传入路径参数,
async def HelloWorld(item:int): # 指定参数类型为int
    # 函数内部调用传入的参数
    return {'helloworld': item}

在此例中传入的参数类型为int 所以当传入的参数为字符串时，将会报错

image.png

4> 路径操作顺序

路径操作是按顺序执行的，当路径相似时，需注意接口函数声明顺序

from  fastapi import FastAPI

# 创建Fastapi实例
app = FastAPI()

@app.get("/path/{item}") # 传入路径参数,指定参数类型为str
async def HelloWorld1(item:str):
    # 函数内部调用传入的参数
    return {'helloworld': item}

@app.get("/path/item") 
async def HelloWorld2():
    # 函数内部调用传入的参数
    return {'helloworld': "helloworld"}

Notes: 在上示例子中，两个接口的路径相似，当传入路径参数时，永远都不会访问第二个接口，即使参数为item

5> 如果接收的路径参数有限， 且希望在API文档中显示出来，可使用Enum

from  fastapi import FastAPI
from enum import Enum

# 创建Fastapi实例
app = FastAPI()

class ModelName(str,Enum):
    develop = "develop"
    debug = "debug"
    test = "test"

@app.get("/{model}") # 传入路径参数,
async def getmodel(model:ModelName): # 指定参数类型为ModelName
    # 函数内部调用传入的参数
    return {'model': model}

image.png

6> 当你的路径参数中包含路径时

OpenAPI 不支持任何方式去声明路径参数以在其内部包含路径，因为这可能会导致难以测试和定义的情况出现
所以必须在路径中特殊说明，增加路径参数， 声明该参数包含路径

from  fastapi import FastAPI
from enum import Enum

# 创建Fastapi实例
app = FastAPI()

@app.get("/file/{file_path:path}") # 传入路径参数,声明参数包含路径
async def readfile(file_path:str): # 指定参数类型为str
    # 函数内部调用传入的参数
    return {'path': file_path}

学习笔记，内容来源于Fastapi社区， 侵权必删
https://fastapi.tiangolo.com/zh/fastapi-people/