首页 > 其他分享> 文章详细

FastAPI 学习之路（八）路径参数和数值的校验

2021-10-17 10:01:46 阅读：174 来源： 互联网

标签：items app 路径 results 校验 FastAPI Query id

系列文章：

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

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）

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

标签：items,app,路径,results,校验,FastAPI,Query,id
来源： https://www.cnblogs.com/leiziv5/p/15416009.html

本站声明： 1. iCode9 技术分享网（下文简称本站）提供的所有内容，仅供技术学习、探讨和分享；
2. 关于本站的所有留言、评论、转载及引用，纯属内容发起人的个人观点，与本站观点和立场无关；
3. 关于本站的所有言论和文字，纯属内容发起人的个人观点，与本站观点和立场无关；
4. 本站文章均是网友提供，不完全保证技术分享内容的完整性、准确性、时效性、风险性和版权归属；如您发现该文章侵犯了您的权益，可联系我们第一时间进行删除；
5. 本站为非盈利性的个人网站，所有内容不会用来进行牟利，也不会利用任何形式的广告来间接获益，纯粹是为了广大技术爱好者提供技术内容和技术思想的分享性交流网站。

ICode9

FastAPI 学习之路（八）路径参数和数值的校验