【大模型应用开发-FastAPI框架】(三)FastAPI路由参数(1)

一、FastAPI的安装

参考

【大模型应用开发-FastAPI框架】(一)FastAPI概述和安装-CSDN博客

二、路径操作装饰器中的路径参数

1、声明路径参数

使用Python格式字符串的语法声明路径参数，例子

from fastapi import FastAPI

app = FastAPI()

@app.get("/items/{item_id}") 
def read_item(item_id):
    return {"item_id": item_id}

上述代码运行之后，路径参数 item_id 的值会作为read_item函数参数 item_id 的值。

因此，如果你运行上述示例，然后跳转到 http://127.0.0.1:8000/items/foo, 你将会看见这样的回应:

{"item_id":"foo"}

2、声明路径参数的类型

使用 标准的Python类型注释在函数中声明路径参数的类型，例子1：

from fastapi import FastAPI

app = FastAPI()

@app.get("/items/{item_id}")
async def read_item(item_id: int):
    return {"item_id": item_id}

上述将参数item_id的类型定义为int类型

例子2：

from fastapi import FastAPI

app = FastAPI()

@app.get("/items/{item_name}")
def read_item(item_name: str):
    return {"item_id": item_name}

上述将参数item_name的类型定义为str类型

当我们声明了路径参数的类型，如果我们在访问链接的时候提供的参数类型不对，FastAPI还会自动为我们做数据校验的功能，在开发和调试与您的API交互的代码时，这非常有用。注意两点：

所有的数据验证都是由 Pydantic实现的.
你可以用同样的类型声明比如 str, float, bool 或者其他更复杂的类型.

3、限定路径参数有效值

有时候我们只想给某个路径参数传递某几个固定的有效值，我们就可以使用到这个方法。先看完整例子代码

from fastapi import FastAPI
import uvicorn

from enum import Enum
from fastapi import FastAPI


class myEnumVal(str, Enum):
    Name = 'zhangsan'
    Year = 27
    Id = '12345'
    student = True


app = FastAPI()


@app.get('/my/{val}')
def root(val: myEnumVal):
    return {'status': val}

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

@app.get("/items/{item_id}")
def read_item(item_id: int):
    return {"item_id": item_id, "q": f"接口id：{item_id}"}

if __name__ == '__main__':
    uvicorn.run('main:app', host='0.0.0.0', port=8000, reload=True, workers=1)

第一步、创建一个继承str和Enum的类，并创建几个类属性，这些类属性的值将是可用的有效值

第二步、声明路径参数。路径参数hjx_man的值将传递给函数root的参数my，并且这个值的取值范围只能是Hjx_Class_name类中类属性的值。

例如你访问http://127.0.0.1:8001/my/12345，得到的会是：{“status”:“12345”}

例如你访问http://127.0.0.1:8001/my/True，得到的会是：{“status”:“True”}

这样我们就能做到给某个路径参数传递某几个固定的有效值了。