声明路径参数
使用Python格式字符串的语法声明路径参数
@app.get("/item/{item_id}")
def read_item(item_id):
return {"item_id": item_id}
代码运行之后,路径参数 item_id 的值会作为read_item函数参数 item_id 的值
声明路径参数的类型
使用 标准的Python类型注释在函数中声明路径参数的类型
@app.get("/item/{item_id}")
def read_item(item_id: int):
return {"item_id": item_id}
上述将参数item_id的类型定义为int类型
当声明了路径参数的类型,如果在访问链接的时候提供的参数类型不对,FastAPI还会自动为我们做数据校验的功能
- 所有的数据验证都是由 Pydantic实现的
- 可以用同样的类型声明比如 str, float, bool 或者其他更复杂的类型
限定路径参数有效值
有时候只想给某个路径参数传递某几个固定的有效值
class HjxClassName(str, Enum):
Name = 'yang'
Year = 26
Id = '0525'
student = False
@app.get("/hjx/{hjx_man}")
def root(hjx_man: HjxClassName):
return {"status": hjx_man}
第一步、创建一个继承str和Enum的类,并创建几个类属性,这些类属性的值将是可用的有效值
第二步、声明路径参数。路径参数hjx_man的值将传递给函数root的参数hjx_man,并且这个值的取值范围只能是HjxClassName类中类属性的值
这样就能做到给某个路径参数传递某几个固定的有效值了
还可以在root函数里面调用这个类的类属性。通过HjxClassName.Name进行调用
@app.get("/hjx/{hjx_man}")
def root(hjx_man: HjxClassName):
return {"status": HjxClassName.Name}
无论使用哪个类属性的值访问,结果都是{"status": "yang"}
路径参数的值是路径类型变量
假设现在有一个路径操作:/files/{file_path},但是需要 file_path 本身包含一个 路径, 比如 home/johndoe/myfile.txt
因此, 文件路径可能是: /files/home/johndoe/myfile.txt
使用Path转换器就可以进行转换了
/files/{file_path:path}
参数的名字是 file_path,:path说明参数file_path对应的类型是 path 类型
@app.get("files/{file_path:path}")
def read_user_me(file_path):
return {"file_path": file_path}