FastApi路径参数Query参数及参数类型

前面讲述了FastApi的搭建与运行，这篇来讲下FastApi的路径参数与查询参数。

路径参数

可以使用与Python格式字符串相同的语法来声明路径参数

from fastapi import FastAPIapp = FastAPI()@app.get("/items/{item_id}")
async def read_item(item_id):return {"item_id": item_id}

上面代码，path参数item_id的值将作为参数传递给read_item函数。

在浏览器中运行一下

可以看到，path为 /items/foo，其中的foo将作为实参传入read_item函数

是不是觉得很简单呢？

Query参数

声明不属于路径参数的其他功能参数时，它们将自动解释为Query参数

from fastapi import FastAPIapp = FastAPI()@app.get("/items")
async def read_item(uid):return {"uid": uid}

来看上面简单例子，这个例子中，没有路径参数，但却有其他的参数uid，这个uid就将解释为Query参数。

Query是在path后面加上?形参名=值，如果有多个查询参数以&字符分隔，比如path?参数名=值&参数名=值，其中的值将被作为实参传入函数。

在上例中转化的URL为：

http://127.0.0.1:8000/items?uid=1

在来看一个多个查询参数的例子

from fastapi import FastAPIapp = FastAPI()@app.get("/items")
async def read_item(uid, aid):return {"uid": uid, "aid": aid}

上例中转化的URL为：

http://127.0.0.1:8000/items?uid=1&aid=2

参数类型

上面几个简单例子，细心一点就会发现，参数的类型可以随便定义，这样可能就会因为用户的随便传入值而报错，比如uid需要的是int类型，用户传了个str类型过来，这时怎么办呢？有没有简单的方式呢？

在FastApi中很方便的帮我们实现了这个功能。

from fastapi import FastAPIapp = FastAPI()@app.get("/items/{uid}")
async def read_item(uid: int, name: str):return {"uid": uid, "name": name}

上面例子中，即含有路径参数也含有Query参数，且路径参数必须为int类型，name必须为str类型，用户必须传指定类型才可以访问成功。

http://127.0.0.1:8000/items/1?name=apple

上面URL访问成功，当用户传入别的类型时就会给出提示信息，比如访问下面连接

http://127.0.0.1:8000/items/hello?name=apple

上面连接的路径参数传了一个str类型，服务器就会给出提示

{
   "detail": [{
       "loc": ["path", "uid"],
       "msg": "value is not a valid integer",
       "type": "type_error.integer"
   }]
}

给出了具体信息，说uid参数的值不是int类型，是不是很方便。

FastApi路径参数Query参数及参数类型相关推荐

JVM参数调优基础-参数的类型详解
1 参数类型 1.1 标准参数 -help -server -client -version -showversion -cp -classpath 1.2 X 参数非标准化参数 -Xint :解释 ...
python函数用法详解2（变量的作用域（全局变量、局部变量）、共享全局变量、函数返回值、函数的参数（位置参数、关键字参数、默认参数、不定长参数）、拆包、交换变量值、引用、可变和不可变类型）
1. 变量作⽤域变量作⽤域指的是变量⽣效的范围,主要分为两类:局部变量和全局变量. 局部变量定义在函数体内部的变量,即只在函数体内部⽣效. def testA(): ...
拷贝构造函数的第一个参数必须是自身类类型的引用
拷贝构造函数的第一个参数必须是自身类类型的引用拷贝构造函数的定义:如果一个构造函数的第一个参数是自身类类型的引用,且任何额外参数都有默认值,则此构造函数是拷贝构造函数第一个参数必须是自身类类型的引 ...
【Kotlin】函数类型 ( 函数类型 | 带参数名称的参数列表 | 可空函数类型 | 复杂函数类型 | 带接收者函数类型 | 函数类型别名 | 函数类型实例化 | 函数调用 )
文章目录 I . 函数类型 II . 带参数名的参数列表 III . 可空函数类型 IV . 复杂函数类型解读 V . 函数类型别名 VI . 带接收者类型的函数类型 VII . 函数类型实例化 ...
验证 Boost.Optional 复制构造函数不会尝试调用从模板化参数初始化构造函数的元素类型
验证 Boost.Optional 复制构造函数不会尝试调用从模板化参数初始化构造函数的元素类型实现功能 C++实现代码实现功能验证 Boost.Optional 复制构造函数不会尝试调用从模板 ...
JVM实用参数（一）JVM类型以及编译器模式
原文地址:https://blog.codecentric.de/en/2012/07/useful-jvm-flags-part-1-jvm-types-and-compiler-modes/ 译者 ...
Query类常用参数详解
主要介绍一下Query类及其常用的参数. 参数介绍 Query里面大概分为四类参数: 分页参数:设置分页排序参数:设置排序字段条件参数:设置查询条件字段参数:可返回指定字段分页参数 Query ...
python参数种类_python的参数类型
Python中函数的参数有4种形式,分别是: 位置或关键字参数(Positional-or-keyword parameter) 仅位置的参数(Positional-only parameter) 任 ...
R语言使用plot函数可视化数据、使用type参数自定义设置可视化的类型（数据点和线关系的类型）、设置type参数为s则为阶梯状显示
R语言使用plot函数可视化数据.使用type参数自定义设置可视化的类型(数据点和线关系的类型).设置type参数为s则为阶梯状显示目录

FastApi路径参数Query参数及参数类型

FastApi路径参数Query参数及参数类型相关推荐

最新文章

热门文章