fastapi 用户指南(路径参数、查询参数、请求体)

文章目录

    • 1. 第一步
      • 1.1 小结
    • 2. 路径参数
      • 2.1 顺序很重要
      • 2.2 预设值
      • 2.3 包含路径的路径参数
    • 3. 查询参数
      • 3.1 查询参数类型转换
    • 4. 请求体

learn from https://fastapi.tiangolo.com/zh/tutorial/

1. 第一步

  • pip install fastapi[all]
from fastapi import FastAPI
my_app = FastAPI() # my_app 实例, 名字对应于 终端里的
@my_app.get("/")
async def root():return {"message" : "Hello World"}

  • http 操作:
    POST:创建数据。
    GET:读取数据。
    PUT:更新数据。
    DELETE:删除数据。

@my_app.get("/") 告诉 FastAPI 在它下方的函数负责处理如下访问请求:

  • 请求路径为 /
  • 使用 get 操作

函数可以返回一个 dictlist,像 strint 一样的单个值,等等。还可以返回 Pydantic 模型

1.1 小结

  • 导入 FastAPI
  • 创建一个 app 实例
  • 编写一个路径操作装饰器(如 @app.get("/")
  • 编写一个路径操作函数(如上面的 def root(): ...
  • 运行开发服务器(如 uvicorn main:app --reload

2. 路径参数

  • 函数参数,与 { } 内的名字,保持一致
@my_app.get("/items/{item_id}")
async def read_item(item_id):  # 要跟上面的 {} 内保持一致return {"itemid": item_id} # 返回字符串
  • 参数类型限制 : type,参数类型不匹配会报错
@my_app.get("/items/{item_id}")
async def read_item(item_id: int):  # 要跟上面的 {} 内保持一致return {"itemid": item_id} # 返回 int
  • 文档 http://127.0.0.1:8000/docshttp://127.0.0.1:8000/redoc

2.1 顺序很重要

@my_app.get("/users/me")
async def read_user_me():return {"user_id": "the current user"}@my_app.get("/users/{user_id}")
async def read_user(user_id: str):return {"user_id": user_id}

在这里插入图片描述
如果上面,两个函数顺序反了,如下结果

在这里插入图片描述

2.2 预设值

  • 使用 Enum
from enum import Enumapp = FastAPI()class ModelName(str, Enum): # 继承string, 枚举, 必须是字符串且是指定的枚举值alexnet = "alexnet"resnet = "resnet"lenet = "lenet"@app.get("/models/{model_name}")
async def get_model(model_name: ModelName):if model_name == ModelName.alexnet:return {"model_name": model_name, "message": "Deep Learning FTW!"}if model_name.value == "lenet":return {"model_name": model_name, "message": "LeCNN all the images"}return {"model_name": model_name, "message": "Have some residuals"}

可以使用 model_name.value 或通常来说 your_enum_member.value 来获取实际的值
在这里插入图片描述
在这里插入图片描述
在这里插入图片描述

2.3 包含路径的路径参数

  • 参数 { } 内 参数名:path :前后均没有空格,不加 :path 无法识别 带有/ 的路径参数
@app.get("/files/{file_path:path}")
async def read_file(file_path: str):return {"file_path": file_path}

3. 查询参数

fake_items_db = [{"item_name": "Foo"}, {"item_name": "Bar"}, {"item_name": "Baz"}]@app.get("/items")
async def read_item(skip: int = 0, limit: int = 10):return fake_items_db[skip:skip + limit]
  • 使用 ? 开始,参数间使用 & 分割
    在这里插入图片描述
from typing import Optional
@app.get("/items/{item_id}")
async def read_item(item_id: str, q: Optional[str] = None):if q:return {"item_id": item_id, "q": q}return {"item_id": item_id}

3.1 查询参数类型转换

from typing import Optional@app.get("/items/{item_id}")
async def read_item(item_id: str, q: Optional[str] = None, short: bool = False):item = {"item_id" : item_id}if q:item.update({"q" : q})if not short:item.update({"description": "This is an amazing item that has a long description"})return item

输入 short=,后面是 1,True, true, yes, on, On, YES 任意变形体都是一样的效果,都是 true
在这里插入图片描述

  • 多个参数的顺序没影响,通过名字查找的
@app.get("/users/{user_id}/items/{item_id}")
async def read_user_item(item_id: str, user_id: int, q: Optional[str] = None, short: bool = False
):item = {"item_id": item_id, "owner_id": user_id}if q:item.update({"q": q})if not short:item.update({"description": "This is an amazing item that has a long description"})return item
  • item_id: str, user_id: int, 更换两个变量的位置,没有关系
    在这里插入图片描述

4. 请求体

请求体是客户端发送给 API 的数据
响应体是 API 发送给客户端的数据

使用 Pydantic 模型来声明请求体

from typing import Optionalfrom Pinyin2Hanzi import Item
from fastapi import FastAPI
from pydantic import BaseModelclass Item(BaseModel):name: strdescription: Optional[str]=Noneprice:floattax:Optional[float] = Noneapp = FastAPI()@app.put("/items/{item_id}")
async def create_item(item_id: int, item: Item, q: Optional[str] = None):result = {"item_id": item_id, **item.dict()}if q:result.update({"q": q})return result

  • 还可以同时声明请求体、路径参数和查询参数。
    函数参数将依次按如下规则进行识别:
    1.如果在路径中也声明了该参数,它将被用作路径参数
    2.如果参数属于单一类型(比如 int、float、str、bool 等)它将被解释为查询参数
    3.如果参数的类型被声明为一个 Pydantic 模型,它将被解释为请求体

本文来自互联网用户投稿,该文观点仅代表作者本人,不代表本站立场。本站仅提供信息存储空间服务,不拥有所有权,不承担相关法律责任。如若转载,请注明出处:http://www.mzph.cn/news/471642.shtml

如若内容造成侵权/违法违规/事实不符,请联系多彩编程网进行投诉反馈email:809451989@qq.com,一经查实,立即删除!

相关文章

mysql format row_MySQL之InnoDB存储引擎:Row Format行格式

MySQL下用的比较多、比较广的存储引擎就属InnoDB。这里我们来介绍下InnoDB存储引擎下数据记录的存储格式——Row Format行格式基本操作在MySQL中,所谓Row Format行格式是指数据记录(或者称之为行)在磁盘中的物理存储方式。具体地,对于InnoDB存储引擎而言…

DirectX API 编程起步 #01 项目设置

目录: DirectX API 编程起步 #02 窗口的诞生 DirectX API 编程起步 #02 创建3D世界 这里记录了我从零开始学习使用 DirectX API 的过程。 参考教程:rastertek -> DirectX 11 Tutorials 准备工作 1)首先我们要有一套能写代码的软件&#…

centos5.8安装mysql5.3_CentOS 5.8 64位 源码安装mysql5.5.28

全新以最小化包安装了64位的CentOS5.8系统mysql5.5数据库v5.5.28地址:http://cdn.mysql.com/Downloads/MySQL-5.5/mysql-5.5.28.tar.gzmysql从5.5版本开始,不再使用./configure编译,而是使用cmake编译器我的mysql目录配置如下:安装…

LeetCode 2016. 增量元素之间的最大差值

文章目录1. 题目2. 解题1. 题目 给你一个下标从 0 开始的整数数组 nums &#xff0c;该数组的大小为 n &#xff0c;请你计算 nums[j] - nums[i] 能求得的 最大差值 &#xff0c;其中 0 < i < j < n 且 nums[i] < nums[j] 。 返回 最大差值 。如果不存在满足要求…

LeetCode 2017. 网格游戏(前缀和)

文章目录1. 题目2. 解题1. 题目 给你一个下标从 0 开始的二维数组 grid &#xff0c;数组大小为 2 x n &#xff0c;其中 grid[r][c] 表示矩阵中 (r, c) 位置上的点数。 现在有两个机器人正在矩阵上参与一场游戏。 两个机器人初始位置都是 (0, 0) &#xff0c;目标位置是 (1,…

mysql ngram_MySQL ngram全文解析器

本教程将向您展示如何使用MySQL ngram全文解析器来支持中文&#xff0c;日文&#xff0c;韩文等表意语言的全文搜索。MySQL ngram全文解析器简介MySQL内置的全文解析器使用空格确定单词的开始和结束。当涉及汉语&#xff0c;日语或韩语等表意语言语言时&#xff0c;这是一个限制…

手机号、姓名、邮箱等合法性验证方法

//邮箱 (BOOL) validateEmail:(NSString *)email{NSString *emailRegex "\\w[a-zA-Z_]?\\.[a-zA-Z]{2,6}";NSPredicate *emailTest [NSPredicate predicateWithFormat:"SELF MATCHES %", emailRegex];return [emailTest evaluateWithObject:email];}//…

zabbix设置mysql登陆免报警_zabbix3.0 监控mysql服务免用户名密码登录的有关问题故障处理详细过程_mysql...

zabbix3.0 监控mysql服务免用户名密码登录的问题故障处理详细过程1&#xff0c;My.cnf中用户名密码无效在azure云上面&#xff0c;使用Zabbix监控mysql中&#xff0c;发现在/usr/local/mysql/my.cnf里面设置的默认用户名密码无效&#xff0c;出不来数据&#xff0c;而且在zabbi…

LeetCode 2018. 判断单词是否能放入填字游戏内(模拟)

文章目录1. 题目2. 解题1. 题目 给你一个 m x n 的矩阵 board &#xff0c;它代表一个填字游戏 当前 的状态。 填字游戏格子中包含小写英文字母&#xff08;已填入的单词&#xff09;&#xff0c;表示 空格 的 和表示 障碍 格子的 # 。 如果满足以下条件&#xff0c;那么我…

链表的相关操作

#include<iostream> using namespace std; struct node {int data;node *next; }; //链表的建立&#xff0c;创建有n个结点的链表 node *create(int n) {node *headNULL;node *pNULL;headnew node();phead;cin>>p->data;node *q;while(--n){qnew node();cin>…

qt优点

&#xff08;1&#xff09;优良的跨平台特性。   Qt支持下列操作系统&#xff1a;Microsoft Windows 95/98、Microsoft Windows NT、Linux、Solaris、SunOS、HP&#xff0d;UX、Digital UNIX &#xff08;OSF/1、Tru64&#xff09;、Irix、FreeBSD、BSD/OS、SCO、AIX、OS390和…

LeetCode 2022. 将一维数组转变成二维数组

文章目录1. 题目2. 解题1. 题目 给你一个下标从 0 开始的一维整数数组 original 和两个整数 m 和 n 。 你需要使用 original 中 所有 元素创建一个 m 行 n 列的二维数组。 original 中下标从 0 到 n - 1 &#xff08;都 包含 &#xff09;的元素构成二维数组的第一行&#xf…

mysql系统自带示例数据库_MySQL系统自带的数据库information schema

information_schema数据库是MySQL系统自带的数据库&#xff0c;它提供了数据库元数据的访问方式。感觉information_schema就像是MySQL实例的一个百科全书&#xff0c;记录了数据库当中大部分我们需要了结的信息&#xff0c;比如字符集&#xff0c;权限相关&#xff0c;数据库实…

Json对象与Json字符串互转(4种转换方式)

最近有用到php的json字符串要转成js对象&#xff0c;以前一直用jq或者eval&#xff0c;又发现了其他的方法&#xff0c;记录下. 1>jQuery插件支持的转换方式&#xff1a; 复制代码代码如下:$.parseJSON( jsonstr ); //jQuery.parseJSON(jsonstr),可以将json字符串转换成jso…

LeetCode 2023. 连接后等于目标字符串的字符串对

文章目录1. 题目2. 解题1. 题目 给你一个 数字 字符串数组 nums 和一个 数字 字符串 target &#xff0c;请你返回 nums[i] nums[j] &#xff08;两个字符串连接&#xff09;结果等于 target 的下标 (i, j) &#xff08;需满足 i ! j&#xff09;的数目。 示例 1&#xff1a…

What day is that day?(快速幂,打表找周期,或者求通项公式)

有些题怎么都解不出来&#xff0c;这时候可以打表&#xff0c;找规律&#xff0c;求通项公式等&#xff0c;这些方法让人拍手叫绝&#xff0c;真不错…… Description Its Saturday today, what day is it after 11 22 33 ... NN days? Input There are multiple test cas…

mysql中数据定义语言_SQL数据定义语言(DDL)

数据库模式定义语言DDL(DataDefinition Language)&#xff0c;是用于描述数据库中要存储的现实世界实体的语言。一个数据库模式包含该数据库中所有实体的描述定义。这些定义包括结构定义、操作方法定义等。DDL描述的模式&#xff0c;必须由计算机软件进行编译&#xff0c;转换为…

瞎搞

declare a int,b int,c int set a (select top 1 a from Table_1 ) set b (select top 1 b from Table_1 ) set c (select top 1 c from Table_1 ) if(a>b and a>c) beginprint(a的值最大)endif(b>a and b>c) beginprint(b的值最大)endif(c>a and c>b) be…

db2 脚本运行错误返回错误原因_电脑运行错误代码大全,遇到报错请自己对照断电原因所在吧...

电脑在运行的时候&#xff0c;会出现一些代码&#xff0c;软件安装不上啊或电脑使用中蓝屏啊出现的代码&#xff0c;每一次出现问题电脑都会以代码的形式反馈&#xff0c;我们就可以凭借错误代码来判断故障源。小编整理了一些常出现的错误代码和问题分享给大家&#xff0c;希望…

LeetCode 2028. 找出缺失的观测数据

文章目录1. 题目2. 解题1. 题目 现有一份 n m 次投掷单个 六面 骰子的观测数据&#xff0c;骰子的每个面从 1 到 6 编号。 观测数据中缺失了 n 份&#xff0c;你手上只拿到剩余 m 次投掷的数据。 幸好你有之前计算过的这 n m 次投掷数据的 平均值 。 给你一个长度为 m 的整…