FastAPI 源码阅读 (四) Endpoint解析

Posted

tags:

篇首语:本文由小常识网(cha138.com)小编为大家整理,主要介绍了FastAPI 源码阅读 (四) Endpoint解析相关的知识,希望对你有一定的参考价值。

参考技术A

当路由找到了匹配的 APIRoute ,会调用其中的 app app 中包含了对model和参数的验证。这对应我们上一章的内容。

我们配置了一个 endpoint 的参数验证,以及其 response model 。我们要将 endpoint 执行前处理参数认证,在其之后处理 response model

这里面定义了一层对endpoint的闭包app,负责在endpoint前后处理认证依赖和模型

solve_dependencies() 包含了对Depends()的认证,也包含了对参数类型的认证。只有通过认证,才能进入到endpoint中
serialize_response() 负责对endpoint的返回结果进行序列化(根据response model),如果直接返回了 response 衍生类,则跳过这步

之前提到过 dependant 将依赖以树状呈现,那么如果想解决依赖,也要从树根开始遍历。
这个函数的逻辑,就好比拿着个小篮子到树上摘苹果。将苹果(某树枝的结果)放在小篮子(values, errors)里。

最简单情况下,一个request经过 fastapi 的流程大致如此,接下来会进行细节分析和扩展内容的了解。

FastAPI 学习之路字符串的校验

系列文章:

  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 源码阅读 (四) Endpoint解析的主要内容,如果未能解决你的问题,请参考以下文章

FastAPI 源码阅读 (一) ASGI应用

FastAPI 源码阅读 (五) 其余主体内容

FastAPI (starlette) 获取客户端真实IP

FastAPI - 支持多种认证依赖

如何在 fastAPI 中返回图像?

fastapi教程翻译(四):Request Body(请求体)