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.mzph.cn/pingmian/59794.shtml

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

相关文章

产品经理如何使用项目管理软件推进复杂项目按时上线

前言 相信很多产品同学或多或少都有过这样的经历:平时没有听到任何项目延期风险,但到了计划时间却迟迟无法提测……评审时没有任何argue,提测后发现开发的功能不是自己想要的……费劲九牛二虎之力终于让项目上线了,然而发现成果达…

新系统如何进行模型环境配置

在机器学习和深度学习中,一个良好的开发环境能够显著提高工作效率。本篇博客将详细介绍如何在新的Linux系统(以Ubuntu为例)上进行模型环境的配置,包括基础系统设置、Python虚拟环境搭建、常用库的安装以及GPU驱动和CUDA的安装等。…

机器视觉:轮廓匹配算法原理

轮廓匹配的模板变量主要包括模板图像(Template)和待检测图像(Source Image) 在轮廓匹配中,模板变量主要包括一下几个关键部分: ‌模板图像(Template)‌:这是进行匹配的…

OpenAI大事记;GPT到ChatGPT参数量进化

目录 OpenAI大事记 GPT到ChatGPT参数量进化 OpenAI大事记 GPT到ChatGPT参数量进化 ChatGPT是从初代 GPT逐渐演变而来的。在进化的过程中,GPT系列模型的参数数量呈指数级增长,从初代GPT的1.17亿个参数,到GPT-2的15 亿个参数,再到 GPT-3的1750 亿个参数。模型越来越大,训练…

STM32移植RT-Thread---时钟管理

一RTT时钟节拍概念 RT-Thread的时钟节拍(Tick)是操作系统用于管理时间和任务调度的一个基本单位。它在实时操作系统中尤为关键,用于实现任务的延时、超时管理等功能。以下是关于RT-Thread时钟节拍的简单说明: 1.Tick定义&#x…

Am I Isolated:一款安全态势基准测试工具

基于Rust的容器运行时扫描器作为一个容器运行,检测用户容器运行时隔离中的漏洞。 它还提供指导,帮助用户改善运行时环境,以提供更强的隔离保证。 容器的现状是它们并不包含(隔离)。 容器隔离的缺失在云原生环境中有…

SQLite的BLOB数据类型与C++二进制存储学习记录

一、BLOB数据类型简介 Blob(Binary Large Object)是一种用于存储二进制数据的数据类型,在数据库中常用于存储图片、音频和视频等大型(大数据量)的二进制数据[1-2]。需要注意的是,SQLite中BLOB类型的单对象最…

编写一个基于React的聊天室

前言 此前已经编写了一版后端的im,此次就用其作为服务端,可查看参考资料1 代码 使用WebStorm创建React项目 安装依赖包 PS C:\learn-demo\front\chatroom> npm installadded 183 packages, and audited 184 packages in 16s43 packages are looki…

Javascript事件循环流程分析

基础概念 事件循环(Event Loop):事件循环是JavaScript运行时环境中的一个循环机制,它不断地检查调栈用和任务队列。当调用栈为空时,事件循环会首先检查微任务队列,并执行其中的所有任务。只有当微任务队列…

解决使用Golang的email库发送qq邮件报错short response,错误类型为textproto.ProtocolError

问题阐述 使用email库发送QQ邮件,采用587端口: package mainimport ("fmt""net/smtp""github.com/jordan-wright/email" )func SendEmail(sendTo string, subject string, body string) (err error) {e : email.NewEmai…

ENAS和DARTs的比较

ENAS(Efficient Neural Architecture Search)和DARTS(Differentiable Architecture Search)都是神经架构搜索(NAS)的有效方法,目标是自动化地找到高性能的神经网络结构。尽管它们都旨在解决NAS的…

题目:Wangzyy的卡牌游戏

登录 - XYOJ 思路: 使用动态规划,设dp[n]表示当前数字之和模三等于0的组合数。 状态转移方程:因为是模三,所以和的可能就只有0、1、2。等号右边的f和dp都表示当前一轮模三等于k的组合数。以第一行为例:等号右边表示 j转…

mysql数据库命令备份和同步

使用mysqldump备份192.168.1.198服务上的test_db数据库 mysqldump --column--statistics0 --set-gtid-purgedOFF -uroot -h 192.168.1.198 -p123456 test_db > /use/local/sql_bak/test_db.sql** 使用mysql再192.168.1.199服务上执行数据库备份文件 ** mysql -h 192.168…

ARM64的Mac Node.js前置工作,nvm在线安装

1,通过 终端 ping raw.githubusercontent.com 获取到ip地址185.199.110.133 2,终端输入sudo vi /etc/hosts,打开hosts文件 3,在最后添加 185.199.110.133 raw.githubusercontent.com 保存后退出 3.1,清除环境 完全…

【支付行业-支付系统架构及总结】

记得第一次看埃隆马斯克(Elon Musk)讲第一性原理的视频时,深受震撼,原来还可以这样处理复杂的事务。这篇文章也尝试化繁为简,探寻支付系统的本质,讲清楚在线支付系统最核心的一些概念和设计理念。 虽然支付…

模块化沙箱:深信达如何为数据安全提供全方位保护

在数字化时代,网络安全已经成为企业和个人不可忽视的重要议题。随着网络攻击手段的日益复杂和多样化,传统的安全防护措施已经难以应对日益严峻的安全挑战。在这样的背景下,模块化沙箱技术应运而生,成为网络安全领域的新宠。今天&a…

基于单片机的观赏类水草养殖智能控制系统的设计(论文+源码)

1总体设计 通过需求分析,本设计观赏类水草养殖智能控制系统的总体架构如图2.1所示,为系统总体设计框图。系统采用STM32单片机作为系统主控核心,利用DS18B20温度传感器、TDS传感器、CO2传感器、光敏传感器实现水草养殖环境中水温、CO2浓度、T…

基于Jeecgboot3.6.3vue3的flowable流程增加online表单的审批支持(四)online表单字段控制

更多技术支持与服务请加入我的知识星球或加我微信,名称:亿事达nbcio技术交流社区https://t.zsxq.com/iPi8F 1、首先需要配置操作规则,如下: 配置这个节点的一些字段属性,上面就是有两个隐藏了,一个可以编辑,上面的规则采用json格式保存到数据库里 2、取出这些规则 //根…

分享:文本转换工具:PDF转图片,WORD转PDF,WORD转图片

前言 鉴于网上大多数在线转换工具要么需要收费,要么免费后但转换质量极差的情况,本人开发并提供了PDF转图片,WORD转PDF,WORD转图片等的文本转换工具。 地址 http://8.134.236.93/entry/login 账号 账号:STAR001&a…

星环大数据平台--TDH部署

1.1 准备一台虚拟机 正常安装一台新的虚拟机, 内存16G,cpu8核,硬盘50G 1.2 安装前系统配置改动 修改/etc/hosts文件,确保hostname该文件包含节点的hostname和IP地址的映射关系列表。 hostname由数字、小写字母或“-”组成&am…