FastAPI 学习之路字符串的校验

Posted 2021-10-17 北漂的雷子

系列文章：

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

　　FastAPI 学习之路（二）

　　FastAPI 学习之路（三）

　　FastAPI 学习之路（四）

　　FastAPI 学习之路（五）

      FastAPI 学习之路（六）查询参数，字符串的校验

我们之前在声明必须的参数的时候呢，我们没有对长度做限定，现在我们要限定长度，长度8-16位。我们怎么来实现这个需求呢。

from fastapi import FastAPI, Query
app = FastAPI()
@app.get("/items/")
def read(paword: str = Query(..., min_length=8,max_length=16)):
    results = {"items": [{"oneid": "shanghai"}, {"two": "beijing"}]}
    if paword:
        results.update({"paword": paword})
    return results

  其实实现起来很简单。这里需要说明：当你在使用 Query 且需要声明一个值是必需的时，可以将 ... 用作第一个参数值。

         那么我们去请求下。测试用例如下：

        1.没有传递paword参数。结果如下：

 

 

   2.传递参数，但是长度不满足

 

 

 

 

 

  两个长度一个是小于8位，一个是大于16位。

 3.传递正确长度参数

 

 

 

 我们假设的需求满足了。可能有人会问...，可以看官方文档的https://docs.python.org/3/library/constants.html#Ellipsis有介绍。

当我们传递 多个值，应该如何实现呢

from fastapi import FastAPI, Query
from typing import List, Optional
app = FastAPI()
@app.get("/items/")
def read(paword: Optional[List[str]] = Query(None)):
    results = {"items": [{"oneid": "shanghai"}, {"two": "beijing"}]}
    if paword:
        results.update({"paword": paword})
    return results

其实很简单，就是传递一个list的参数，那么我们去请求下。

        1.输入两个字测试，

 

  2.输入两个值测试

 

      这样满足了我们的需求，我们可以看下接口文档。

 

 

 接口文档我们也是可以传递多个参数的。当然我们在query还可以传递很多内容，如：

     alias#别名参数

         

     title#标题

 

          description #描述，会在借口文档有表述

deprecated#弃用参数

 

还有特定的校验

 

• min_length

• max_length

• regex

 

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

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）

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