FastAPI —— 请求参数验证

1.hello world 给后端船数据

hello world 接口给后端传 COVID-19 感染数据_高性能 FastAPI 框架入门精讲-慕课网

#!/usr/bin/python3
# -*- coding:utf-8 -*-
# __author__ = '__Jack__'from typing import Optionalfrom fastapi import FastAPI
from pydantic import BaseModelapp = FastAPI()  # 这里不一定是app,名字随意class CityInfo(BaseModel):province: strcountry: stris_affected: Optional[bool] = None  # 与bool的区别是可以不传,默认是null# @app.get('/')
# def hello_world():
#     return {'hello': 'world'}
#
#
# @app.get('/city/{city}')
# def result(city: str, query_string: Optional[str] = None):
#     return {'city': city, 'query_string': query_string}
#
#
# @app.put('/city/{city}')
# def result(city: str, city_info: CityInfo):
#     return {'city': city, 'country': city_info.country, 'is_affected': city_info.is_affected}
#@app.get('/')
async def hello_world():return {'hello': 'world'}@app.get('/city/{city}')
async def result(city: str, query_string: Optional[str] = None):return {'city': city, 'query_string': query_string}@app.put('/city/{city}')
async def result(city: str, city_info: CityInfo):return {'city': city, 'country': city_info.country, 'is_affected': city_info.is_affected}# 启动命令:uvicorn hello_world:app --reload

2.swaggerUI界面

FastAPI 的 API 交互文档 - Swagger UI 和 ReDoc_高性能 FastAPI 框架入门精讲-慕课网

讲的是swagger中的docs和redoc的作用,各关键地方的作用用法

3.路径参数和数据的解析、验证

路径参数和数据的解析、验证_高性能 FastAPI 框架入门精讲-慕课网

4.查询参数和数据的解析、验证

查询参数和数据的解析、验证_高性能 FastAPI 框架入门精讲-慕课网

5.请求体以及混合参数

请求体以及混合参数_高性能 FastAPI 框架入门精讲-慕课网

6.如何定义数据格式嵌套的请求体

如何定义数据格式嵌套的请求体?_高性能 FastAPI 框架入门精讲-慕课网

7.如何设置Cookie和Header参数

如何设置 Cookie 和 Header 参数?_高性能 FastAPI 框架入门精讲-慕课网

#!/usr/bin/python3
# -*- coding:utf-8 -*-
# __author__ = '__Jack__'from datetime import date
from enum import Enum
from typing import Optional, Listfrom fastapi import APIRouter, Query, Path, Body, Cookie, Header
from pydantic import BaseModel, Fieldapp03 = APIRouter()"""Path Parameters and Number Validations 路径参数和数字验证"""@app03.get("/path/parameters")
def path_params01():return {"message": "This is a message"}@app03.get("/path/{parameters}")  # 函数的顺序就是路由的顺序
def path_prams02(parameters: str):return {"message": parameters}class CityName(str, Enum):Beijing = "Beijing China"Shanghai = "Shanghai China"@app03.get("/enum/{city}")  # 枚举类型的参数
async def latest(city: CityName):if city == CityName.Shanghai:return {"city_name": city, "confirmed": 1492, "death": 7}if city == CityName.Beijing:return {"city_name": city, "confirmed": 971, "death": 9}return {"city_name": city, "latest": "unknown"}@app03.get("/files/{file_path:path}")  # 通过path parameters传递文件路径
def filepath(file_path: str):return f"The file path is {file_path}"@app03.get("/path_/{num}")
def path_params_validate(num: int = Path(..., title="Your Number", description="不可描述", ge=1, le=10),
):return num"""Query Parameters and String Validations 查询参数和字符串验证"""@app03.get("/query")
def page_limit(page: int = 1, limit: Optional[int] = None):  # 给了默认值就是选填的参数,没给默认值就是必填参数if limit:return {"page": page, "limit": limit}return {"page": page}@app03.get("/query/bool/conversion")  # bool类型转换:yes on 1 True true会转换成true, 其它为false
def type_conversion(param: bool = False):return param@app03.get("/query/validations")  # 长度+正则表达式验证,比如长度8-16位,以a开头。其它校验方法看Query类的源码
def query_params_validate(value: str = Query(..., min_length=8, max_length=16, regex="^a"),  # ...换成None就变成选填的参数values: List[str] = Query(["v1", "v2"], alias="alias_name")
):  # 多个查询参数的列表。参数别名return value, values"""Request Body and Fields 请求体和字段"""class CityInfo(BaseModel):name: str = Field(..., example="Beijing")  # example是注解的作用,值不会被验证country: strcountry_code: str = None  # 给一个默认值country_population: int = Field(default=800, title="人口数量", description="国家的人口数量", ge=800)class Config:schema_extra = {"example": {"name": "Shanghai","country": "China","country_code": "CN","country_population": 1400000000,}}@app03.post("/request_body/city")
def city_info(city: CityInfo):print(city.name, city.country)  # 当在IDE中输入city.的时候,属性会自动弹出return city.dict()"""Request Body + Path parameters + Query parameters 多参数混合"""@app03.put("/request_body/city/{name}")
def mix_city_info(name: str,city01: CityInfo,city02: CityInfo,  # Body可以是多个的confirmed: int = Query(ge=0, description="确诊数", default=0),death: int = Query(ge=0, description="死亡数", default=0),
):if name == "Shanghai":return {"Shanghai": {"confirmed": confirmed, "death": death}}return city01.dict(), city02.dict()@app03.put("/request_body/multiple/parameters")
def body_multiple_parameters(city: CityInfo = Body(..., embed=True),  # 当只有一个Body参数的时候,embed=True表示请求体参数嵌套。多个Body参数默认就是嵌套的confirmed: int = Query(ge=0, description="确诊数", default=0),death: int = Query(ge=0, description="死亡数", default=0),
):print(f"{city.name} 确诊数:{confirmed} 死亡数:{death}")return city.dict()"""Request Body - Nested Models 数据格式嵌套的请求体"""class Data(BaseModel):city: List[CityInfo] = None  # 这里就是定义数据格式嵌套的请求体date: date  # 额外的数据类型,还有uuid datetime bytes frozenset等,参考:https://fastapi.tiangolo.com/tutorial/extra-data-types/confirmed: int = Field(ge=0, description="确诊数", default=0)deaths: int = Field(ge=0, description="死亡数", default=0)recovered: int = Field(ge=0, description="痊愈数", default=0)@app03.put("/request_body/nested")
def nested_models(data: Data):return data"""Cookie 和 Header 参数"""@app03.get("/cookie")  # 效果只能用Postman测试
def cookie(cookie_id: Optional[str] = Cookie(None)):  # 定义Cookie参数需要使用Cookie类,否则就是查询参数return {"cookie_id": cookie_id}@app03.get("/header")
def header(user_agent: Optional[str] = Header(None, convert_underscores=True), x_token: List[str] = Header(None)):"""有些HTTP代理和服务器是不允许在请求头中带有下划线的,所以Header提供convert_underscores属性让设置:param user_agent: convert_underscores=True 会把 user_agent 变成 user-agent:param x_token: x_token是包含多个值的列表:return:"""return {"User-Agent": user_agent, "x_token": x_token}

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

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

相关文章

python画图|hist()函数深层体验

【1】引言 前述学习已经掌握hist()函数的基本运用技巧,可通过下述链接直达: python画图|hist()函数画直方图初探-CSDN博客 python画图|hist()函数画直方图进阶-CSDN博客 我们已经理解hist()函数本质上画的是概率分布图,相关知识属于数理统…

火狐浏览器同源策略禁止解决方案

前言 火狐浏览器同源策略禁止解决方案_同源策略禁止读取远程资源怎么办-CSDN博客 在使用Firefox火狐浏览器进行Web开发时,有时会遇到因为同源策略(Same-Origin Policy)导致的跨域请求被拦截的问题。例如,控制台可能会显示如下错…

计算机网络——TCP篇

TCP篇 基本认知 TCP和UDP的区别? TCP 和 UDP 可以使用同一个端口吗? 可以的 传输层中 TCP 和 UDP在内核中是两个完全独立的软件模块。可以根据协议字段来选择不同的模块来处理。 TCP 连接建立 TCP 三次握手过程是怎样的? 一次握手:客户端发送带有 …

解决ImportError: DLL load failed while importing _message: 找不到指定的程序。

C:\software\Anoconda\envs\yolov5_train\python.exe C:\Project\13_yolov5-master\train.py C:\software\Anoconda\envs\yolov5_train\lib\site-packages\torchvision\io\image.py:13: UserWarning: Failed to load image Python extension: [WinError 127] 找不到指定的程序…

AOSP沙盒android 11

这里介绍一下aosp装系统 什么是aosp AOSP(Android Open Source Project)是Android操作系统的开源版本。 它由Google主导,提供了Android的源代码和相关工具,供开发者使用和修改。 AOSP包含了Android的核心组件和API,使…

git提交冲突的原因及解决方案

一、场景一 1.冲突原因 提交者的版本库 < 远程库 要保障提交者的版本库信息和远程仓库是一致的 2.解决方案 实现本地同步git pull,再提交代码&#xff08;最好每次git push之前都git pull一下&#xff0c;防止这种情况的出现&#xff09; 场景二 1.冲突原因 别人跟你…

第十五届蓝桥杯C/C++B组题解——数字接龙

题目描述 小蓝最近迷上了一款名为《数字接龙》的迷宫游戏&#xff0c;游戏在一个大小为N N 的格子棋盘上展开&#xff0c;其中每一个格子处都有着一个 0 . . . K − 1 之间的整数。游戏规则如下&#xff1a; 从左上角 (0, 0) 处出发&#xff0c;目标是到达右下角 (N − 1, N …

得物多模态大模型在重复商品识别上的应用和架构演进

重复商品治理介绍 根据得物的平台特性&#xff0c;同一个商品在平台上不能出现多个链接&#xff0c;原因是平台需要保证一品一链的特点&#xff0c;以保障商品的集中竞价&#xff0c;所以说一个商品在整个得物平台上只能有一个商详链接&#xff0c;因此我们需要对一品多链的情…

盘点2024年惊艳的10款录屏工具!!

你是否经常需要捕捉电脑屏幕上的精彩瞬间&#xff1f;或者想要记录自己操作某个应用程序的流程&#xff1f;这时候你就需要一款录屏工具啦&#xff01;在学习、工作和娱乐中&#xff0c;录屏工具都能成为你的得力助手。无论你是做教学视频、游戏解说还是分享精彩瞬间&#xff0…

vue+websocket实现即时聊天平台

目录 1 什么是websocket 2 实现步骤 2.1 导入依赖 2.2 编写代码 1 什么是websocket WebSocket 是一种在单个 TCP 连接上进行全双工通信的协议。它主要用于在客户端和服务器之间建立持久的连接&#xff0c;允许实时数据交换。WebSocket 的设计目的是为了提高 Web 应用程序的…

软件设计师-上午题-15 计算机网络(5分)

计算机网络题号一般为66-70题&#xff0c;分值一般为5分。 目录 1 网络设备 1.1 真题 2 协议簇 2.1 真题 3 TCP和UDP 3.1 真题 4 SMTP和POP3 4.1 真题 5 ARP 5.1 真题 6 DHCP 6.1 真题 7 URL 7.1 真题 8 浏览器 8.1 真题 9 IP地址和子网掩码 9.1 真题 10 I…

C++:map 和 set 的使用

前言 平衡二叉搜索树 ( AVL树 ) 由于二叉搜索树在特殊情况下&#xff0c;其增删查的效率会降低到 O ( N )&#xff0c;因此对二叉搜索树进行改良&#xff0c;通过旋转等方式将其转换为一个左右均衡的二叉树&#xff0c;这样的树就称为平衡二叉搜索树&#xff0c;又称 AVL树。…

Vue 自定义icon组件封装SVG图标

通过自定义子组件CustomIcon.vue使用SVG图标&#xff0c;相比iconfont下载文件、重新替换更节省时间。 子组件包括&#xff1a; 1. Icons.vue 存放所有SVG图标的path 2. CustomIcon.vue 通过icon的id索引对应的图标 使用的时候需要将 <Icons></Icons> 引到使用的…

面相小白的php反序列化漏洞原理剖析

前言 欢迎来到我的博客 个人主页:北岭敲键盘的荒漠猫-CSDN博客 本文整理反序列化漏洞的一些成因原理 建议学习反序列化之前 先对php基础语法与面向对象有个大体的了解 (我觉得我整理的比较细致&#xff0c;了解这俩是个啥就行) 漏洞实战情况 这个漏洞黑盒几乎不会被发现&am…

ReactPress:深入解析技术方案设计与源码

ReactPress Github项目地址&#xff1a;https://github.com/fecommunity/reactpress 欢迎提出宝贵的建议&#xff0c;欢迎一起共建&#xff0c;感谢Star。 ReactPress是一个基于React框架开发的开源发布平台&#xff0c;它不仅仅是一个简单的博客系统&#xff0c;更是一个功能全…

canal1.1.7使用canal-adapter进行mysql同步数据

重要的事情说前面&#xff0c;canal1.1.8需要jdk11以上&#xff0c;大家自行选择&#xff0c;我这由于项目原因只能使用1.1.7兼容版的 文章参考地址&#xff1a; canal 使用详解_canal使用-CSDN博客 使用canal.deployer-1.1.7和canal.adapter-1.1.7实现mysql数据同步_mysql更…

SpringBoot之定时任务

1. 前言 本篇博客是个人的经验之谈&#xff0c;不是普适的解决方案。阅读本篇博客的朋友&#xff0c;可以参考这里的写法&#xff0c;如有不同的见解和想法&#xff0c;欢迎评论区交流。如果此篇博客对你有帮助&#xff0c;感谢点个赞~ 2. 场景 我们讨论在单体项目&#xff0c…

绿色能源发展关键:优化风电运维体系

根据QYResearch调研团队最新发布的《全球风电运维市场报告2023-2029》显示&#xff0c;预计到2029年&#xff0c;全球风电运维市场的规模将攀升至307.8亿美元&#xff0c;并且在接下来的几年里&#xff0c;其年复合增长率&#xff08;CAGR&#xff09;将达到12.5%。 上述图表及…

前端 Canvas 绘画 总结

目录 一、使用案例 1、基础使用案例 2、基本案例改为直接JS实现 二、相关资料 1、API教程文档 2、炫酷案例 一、使用案例 1、基础使用案例 使用Canvas的基本步骤&#xff1a; 1、需要一个canvas标签 2、需要获取 画笔 对象 3、使用canvas提供的api进行绘图 <!--…

力扣排序455题(分发饼干)

假设你是一位很棒的家长&#xff0c;想要给你的孩子们一些小饼干。 但是&#xff0c;每个孩子最多只能给一块饼干。 对每个孩子 i&#xff0c;都有一个胃口值 g[i],这是能 让孩子们满足胃口的饼干的最小尺寸;并且每块饼 干j&#xff0c;都有一个尺寸 s[j]。如果 s[j]> g[i]&…