FastAPI 学习之路(八)路径参数和数值的校验

系列文章:

  FastAPI 学习之路(一)fastapi--高性能web开发框架

  FastAPI 学习之路(二)

  FastAPI 学习之路(三)

  FastAPI 学习之路(四)

  FastAPI 学习之路(五)

      FastAPI 学习之路(六)查询参数,字符串的校验

  FastAPI 学习之路(七)字符串的校验

 与使用 Query 为查询参数声明更多的校验和元数据的方式相同,你也可以使用 Path 为路径参数声明相同类型的校验和元数据。我们看下如何来实现

from fastapi import FastAPI, Path, Query
app = FastAPI()
@app.get("/items/{id}")
def read_items(
    id: int = Path(..., title="id"),
    q: Optional[str] = Query(None, alias="item-query"),
):
    results = {"item_id": id}
    if q:
        results.update({"q": q})
    return results

我们看下在接口文档的请求。

 

 

可以正常请求,我们可以看到,我们q参数在请求的时候是使用item-query    请求的。正常我们接受是用q接受即可。

        对于必需参数,我们没有顺序要求,但是有默认值的参数必须放在没有默认值的后面,不然python会报错。我们可以代码去演示下如下图:

 

 

如果我们想对参数排序怎么做呢,很简单。

from fastapi import FastAPI, Path, Query
app = FastAPI()
@app.get("/items")
def read_items(*,
    id: int,q:str
):
    results = {"item_id": id}
    if q:
        results.update({"q": q})
    return results

我们会有这样的需求,让id大于多少才给返回,如何实现呢

from fastapi import FastAPI,Query
app = FastAPI()
@app.get("/items")
def read_items(*,id: int=Query(...,ge=5,),q:str):
    results = {"item_id": id}
    if q:
        results.update({"q": q})
    return results

我们来请求下看下结果

 

         那么当我们大于5的时候请求。

 

 

这样就满足了我们的需求啊。还有大于和小于等于

而且你还可以声明数值校验:

gt:大于(greater than)

ge:大于等于(greater than or equal)

lt:小于(less than)

le:小于等于(less than or equal)

文章首发在公众号,欢迎关注。

posted @ 2021-10-17 09:49  北漂的雷子  阅读(1802)  评论(0编辑  收藏  举报