python fastapi 入门教程，每个案例都使用postman进行测试写的接口

置顶 已于 2022-06-30 14:59:10 修改
阅读量2.1w 收藏 35
点赞数 16
文章标签： python
于 2022-06-20 09:38:27 首次发布
版权声明：本文为博主原创文章，遵循 CC 4.0 BY-SA 版权协议，转载请附上原文出处链接和本声明。
本文链接：https://blog.csdn.net/aaaaaaaaanjjj/article/details/125366398
版权
本文详细介绍了FastAPI的基本使用，包括安装、GET/POST请求、JSON参数嵌套、请求体字段、参数字段嵌套、返回结果限制、异常信息处理、接口文档、全局依赖设置和启动服务器。通过实例展示了如何处理各种请求参数、返回字段过滤和异常处理，帮助读者快速掌握FastAPI核心功能。
摘要由CSDN通过智能技术生成

python fastapi 入门教程

一、安装和基本运行访问

在这里插入图片描述
在这里插入图片描述
官方示例代码

from typing import Union

from fastapi import FastAPI

app = FastAPI()


@app.get("/")
def read_root():
    return {"Hello": "World"}


@app.get("/items/{item_id}")
def read_item(item_id: int, q: Union[str, None] = None):
    return {"item_id": item_id, "q": q}

运行命令：uvicorn test:app --reload
注意：运行命令app前面那个是文件位置，官方的文件名叫main，要以实际的文件名为准，不然找不到app
在这里插入图片描述

在这里插入图片描述
在这里插入图片描述

二、post请求和json参数嵌套

1、post请求 写法一：一层参数

class Hero(BaseModel):
    q:str
    w:str
    e:str
    # 可以为不传这个自动也可以传字符串，不传这个字段时该字段默认值为None
    r:Union[str, None] = None

@app.post('/ya_suo')
def ya_suo(hero:Hero):
    print(hero.r)
    #取值
    if hero.r==None:
        return '大招都没有'
    return hero

测试无r参数情况
在这里插入图片描述测试有r参数情况
在这里插入图片描述

2、post请求 写法二：参数嵌套

2.1、错误写法

@app.post('/ti_mo')
def ti_mo(q:str,w:str,e:str,r:Union[str, None] = None):
    a={"q技能":q,"w技能":w,"e技能":e,"r技能":r}
    return a

报错了
在这里插入图片描述

2.2、正确写法

这样才行q:str,这种只用于路径参数,因为r可以为空或者不写，可以不用是路径参数

@app.post('/ti_mo1/{cd}')
def ti_mo1(cd:str,r:Union[str, None] = None):
    a={"技能cd":str(cd)+'s',"r技能":r}
    return a

@app.post('/ti_mo1/{cd}')
def ti_mo1(cd:str,r:Union[str, None] = None):
    a={"技能cd":str(cd)+'s',"r技能":r}
    return a

在这里插入图片描述

2.3、嵌套多个请求参数(不明白的话看下面的postman的请求参数就懂了)

#这2个就直接用官方写的了
class Item(BaseModel):
    name: str
    description: Union[str, None] = None
    price: float
    tax: Union[float, None] = None
class User(BaseModel):
    username: str
    full_name: Union[str, None] = None

@app.post('/q_t/{id}')
def q_t(id:int,item:Item,user:User):
    return {'id':id,'item':item,'user':user}

在这里插入图片描述

2.4、嵌套单个请求参数(细节max)(不明白的话看下面的postman的请求参数就懂了~)

#只有嵌套单个请求体的话请求参数和多个是有很大区别的
@app.post('/q_t1/{id}')
def q_t1(id:int,user:User):
    return {'id':id,'user':user}

注意：重点在发起请求的时候
希望请求参数格式

{
    "user": {
        "username": "dave",
        "full_name": "Dave Grohl"
    }
}

可是现在会报错
在这里插入图片描述
要这样才会成功，可是这不是我们想要的结果
在这里插入图片描述
按照官方的解决办法，在我这有点问题
在这里插入图片描述
告诉我确实一个参数（可能版本有啥问题把）
在这里插入图片描述
缺少我就先补上这个参数试试，发现就能正常使用了

@app.post('/q_t1/{id}')
def q_t1(id:int,user:User= Body(...,embed=True)):
    return {'id':id,'user':user}

最终测试
在这里插入图片描述

三、请求体 - 字段Field

#字段Field
class Item(BaseModel):
    name: str
    description: Union[str, None] = Field(
        default='默认值', title="这是一个商品", max_length=300
    )
    price: float = Field(gt=0, description="商品价格必须大于0")
    tax: Union[float, None] = None


@app.post("/items/{item_id}")
def update_item(item_id: int, item: Item = Body(...,embed=True)):
    results = {"item_id": item_id, "item": item}
    return results

gt=0的意思，看源码字段的解释
在这里插入图片描述
测试商品价格小于等于0的情况
在这里插入图片描述
测试正常情况
在这里插入图片描述

四、请求参数字段使用字典列表集合嵌套

#请求参数字段使用字典列表集合嵌套
class Image(BaseModel):
    #检查是否为有效的url
    url: HttpUrl
    name: str

class Item(BaseModel):
    name: str
    # 参数格式：字符串或者为空不传这个字段
    description: Union[str, None] = None
    price: float
    # 参数格式：小数或者为空不传这个字段
    tax: Union[float, None] = None
    tags: Set[str] = set()
    #参数格式：列表里面包含字典或者为空不传这个字段
    images: Union[List[Image], None] = None

@app.post('/qtt/{id}')
def qtt(id:int,item:Item):
    return {"id": id, "item": item}

字段设置说明
在这里插入图片描述
测试结果和请求参数：使用 tags: Set[str] = set()，我重复的写了一个"metal",，被去重了，列表嵌套字典
在这里插入图片描述

五、返回结果限制返回字段

#创建一个有明文密码的输入模型和一个没有明文密码的输出模型,让密码不返回
class UserRequest(BaseModel):
    username: str
    password: str


class UserResponse(BaseModel):
    username: str


#response_model=UserResponse  设置返回模型的字段，返回结果会过滤掉未在输出模型中声明的字段数据
@app.post("/user", response_model=UserResponse)
def create_user(user: UserRequest):
    #只会返回username信息
    return user

返回模型的字段不能出现请求模型字段没有的字段
在这里插入图片描述
测试，没有返回密码字段
在这里插入图片描述

六、异常信息处理

#基本使用异常信息
e=[1,2,4,5,6,9]
@app.get('/err/{id}')
def err(id:int):
    if id not in e:
        raise HTTPException(status_code=404,detail='id不存在')
    return {'id':id}

输入id为3，不存在的结果
在这里插入图片描述
输入id为1，存在的结果
在这里插入图片描述

七、接口文档

http://127.0.0.1:8000/docs
在这里插入图片描述

八、全局依赖设置全局token，name在header里面校验，获取header的信息作为变量使用

from fastapi import Depends, FastAPI, Header, HTTPException

#token: str = Header(...) header信息使用
def verify_token(token: str = Header(...)):
    if token != "em123dca":
        raise HTTPException(status_code=400, detail="Token 无效")
#方法名字没啥要求
def name(name: str = Header(...)):
    if name != "lcf":
        raise HTTPException(status_code=400, detail="该用户没有权限访问")

#全局依赖
app = FastAPI(dependencies=[Depends(verify_token), Depends(name)])


@app.get("/header_token")
#可以这样获取header的信息（做一些token信息解析）,应该有其他方法的，没找到，谁找到告诉我一下
def get_token(name: str = Header(...),token: str = Header(...)):
    return {'name':name,'token':token}

测试：正确的token和有权限的name
在这里插入图片描述测试：正确的token和无权限的name
在这里插入图片描述
测试：错误的token和有权限的name
在这里插入图片描述
都错误的话先校验token的，因为方法写在前面
在这里插入图片描述

九、启动服务器的第二种方式，让同局域网下用户可以访问

查询下自己的局域网ip地址

python查询ip地址
在这里插入图片描述

cmd查询ip地址
在这里插入图片描述
在这里插入图片描述

from fastapi import FastAPI

app = FastAPI()
@app.get("/")
def s():
    return '局域网测试12'

if __name__ == '__main__':
    import uvicorn
    uvicorn.run(app='test2:app',host='192.168.11.177',port=8001, reload=True)

在这里插入图片描述

测试
在这里插入图片描述
优化下启动代码

#!/usr/bin/env python
# -*- coding: utf-8 -*-
'''
@time    : 2022/6/21 
@Author  : LL
@File    : test2.py
'''
from fastapi import FastAPI
def get_ip():
    import socket
    res = socket.gethostbyname(socket.gethostname())
    return res

app = FastAPI()
@app.get("/")
def s():
    return '局域网测试12'

if __name__ == '__main__':
    import uvicorn
    #app='test2:app'  文件位置:app
    uvicorn.run(app='test2:app',host=get_ip(),port=8001, reload=True)
亚索不会吹风
关注
Postman导出Python脚本进行接口测试的操作方法
公众号已改名为-程序员阿沐
02-19 450
Postman导出Python脚本进行接口测试的操作方法
FastAPI使用教程【更新中】
什么都干的派森
06-27 9051
二、模板 创建 main.py 文件，内容如下 三、启动命令 ps：127.0.0.1:8000 127.0.0.1:8000/docs【Swagger UI 提供的api文档】 127.0.0.1:8000/redoc【ReDoc 提供的api文档】 代码 调用方法 2.指定数据类型的路径参数 代码 调用方法 3.枚举路径参数 代码 调用方法 4.匹配所有路径 代码 调用方法 5.普通传参 代码 调用方法 6.必备参数 代码 调用....................................
基于python、postman的客达天下系统测试接口测试CRM
05-31
基于python、postman的客达天下系统测试
FastAPI().post(“/retrieve“)在postman中发送请求和接受响应
最新发布
jianbiao1483的博客
07-29 159
注：以下来源于chatgpt。
【最快入门】一篇文章学会Python最快框架fastapi
qq_38196449的博客
05-20 1150
fastapi，一个用于构建 API 的现代、快速（高性能）的web框架。fastapi是建立在和基础上的，Pydantic是一个基于Python类型提示来定义数据验证、序列化和文档的库。Starlette是一种轻量级的ASGI框架/工具包，是构建高性能服务的理性选择。快速：可与 NodeJS 和 Go 比肩的极高性能（归功于Starlette和Pydantic），是最快的 Python web 框架之一。高效编码：提高功能开发速度约 200％ 至 300％。
Python-FastAPI框架使用介绍
wt334502157的博客
04-16 7613
FastAPI 关键特性 1. **快速高效**：基于 Starlette 和 Pydantic 构建，具有高性能和低延迟的特点，支持异步处理请求，利用 Python 的协程提高并发性能。 2. **简单易用**：使用标准的 Python 类型注解来定义 API 的输入和输出参数，无需编写大量的文档和验证代码。 3. **自动生成文档**：通过访问 `/docs` 路径可以查看自动生成的交互式 API 文档，包含了每个端点的详细说明、请求和响应的模型结构以及示例请求和响应。 4. **数据验证**：利用
FastAPI 教程翻译 - Python 类型介绍
人生苦短，我用Python！
05-30 566
FastAPI 教程翻译 - Python 类型介绍 Python Types Intro Python 3.6+ has support for optional “type hints”. Python 3.6+ 支持可选的『类型提示』。 These “type hints” are a new syntax (since Python 3.6+) that allow declaring the type of a variable. 这些**『类型提示』**是一种新语法（自 Python 3.6+
FastAPI 快速入门
热门推荐
weixin_53906838的博客
03-21 1万+
👑 FastAPI 学习记录 文章目录👑 FastAPI 学习记录😉前言一、👻FastApi？？1.😎FastAPI可以做什么2.🚲为什么要学习 FastAPI二、安装FastAPI1.✨编译器工具2.🎫python安装教程3.🎟pycharm安装教程 😉前言 提示： 文章为个人学习心得 如有冒犯 call me！ 🛴快点做！！！！** 一、👻FastApi？？ 😀----😃----连----😃----接----😄----线----😆 1.😎FastAPI可以做什么 🍳由Sebastian Rami
接口测试之Postman使用全图文指南(原来使用Postman测试API接口如此简单)
09-20
本文将全面解析如何使用Postman进行API接口测试，让你轻松掌握这一强大的工具。 一、Postman简介 Postman是一款跨平台的应用程序，支持Windows、Mac和Linux操作系统。它提供了一个直观的界面，允许用户发送HTTP...
PostMan接口测试(很全面的接口测试教程)
01-27
在前后端分离开发时，后端工作人员完成系统接口开发后，需要与前端人员...市场上有很多优秀的，完善的接口测试工具，比如SoapUI，Postman，JMeter、yapi等，能够高效的帮助后端开发人员独立进行接口测试。这里使用Postm
fastapi：FastAPI教程
01-28
FastAPI教程 作者：Navule Pavan Kumar Rao 码 :laptop_computer: 视频 :television: 文章 :memo: --
【Python+requests】使用requests模块对post接口进行测试，与Postman代码比较
01-20
康爱多大药房的登录接口。 接口地址：https://tstuser.360kad.com/Login/AjaxLoginV2 请求方式：post 功能说明：登录 登录成功：{“Code”:”1″,”Result”:true,”Message”:”登录成功！”,”Data”:null} 登录...
Python - FastAPI 实现 get、post 请求
BITDDD小栈
09-19 4621
使用 FastAPI 搭建 Server Demo 与 get、post 操作示例。
FastAPI教程I
a_blade_of_grass的博客
06-28 1343
你可以为查询参数声明额外的校验和元数据。aliastitledeprecatedmin_lengthmax_lengthregex你可以添加多个请求体参数到路径操作函数中，即使一个请求只能有一个请求体。但是 FastAPI 会处理它，在函数中为你提供正确的数据，并在路径操作中校验并记录正确的模式。你还可以声明将作为请求体的一部分所接收的单一值。你还可以指示 FastAPI 在仅声明了一个请求体参数的情况下，将原本的请求体嵌入到一个键中。
python的FastAPI 快速入门
shengjk1的博客
03-20 730
本文介绍了使用 FastAPI 构建 API 的基本知识，包括 FastAPI 的特性、安装、基本使用、HTTP 方法、中间件和异常处理。文章以简洁明了的方式介绍了 FastAPI 的优势和基本操作，适合初学者快速入门。
FastAPI 入门教程
lilygg的博客
05-12 4284
前提：python3 pycharm linux 均已准备就绪 1.安装部署 1.创建虚拟环境 [root@localhost ~]# mkdir -p /tmp/test/flast [root@localhost ~]# cd /tmp/test/flast [root@localhost flast]# python3 -m venv venv [root@localhost flast]# . venv/bin/activate (venv) [root@localhost flast]..
python api 框架_Python web框架fastapi教程
weixin_39929259的博客
11-24 137
fastapi发表时间：2020-03-09最新的变化¶0.52.0¶使用添加新的高性能JSON响应类orjson。新文档：自定义响应-HTML，流，文件等：ORJSONResponse。PR＃1065。0.5-1.0¶从Starlette重新导出实用程序：这样就可以使用from fastapi.responses import JSONResponse代替之类的东西from starlette....
使用FastAPI for Python构建应用实战教程
WPHunter的编程技术资料库！
01-09 1833
FastAPI是一个快速和轻量级的网络框架，用于使用Python3.6及以上版本构建现代应用编程接口。在本教程中，我们将介绍用FastAPI构建应用程序的基础知识。 ​
评论 8
添加红包

请填写红包祝福语或标题

个

红包个数最小为10个

元

红包金额最低5元

当前余额3.43元 前往充值 >
需支付：10.00元
成就一亿技术人!
领取后你会自动成为博主和红包主的粉丝 规则
hope_wisdom
发出的红包

打赏作者

亚索不会吹风

你的鼓励将是我创作的最大动力

¥1 ¥2 ¥4 ¥6 ¥10 ¥20
扫码支付：¥1
获取中
扫码支付

您的余额不足，请更换扫码支付或充值

打赏作者

实付元
使用余额支付
点击重新获取
扫码支付
钱包余额 0

抵扣说明：

1.余额是钱包充值的虚拟货币，按照1:1的比例进行支付金额的抵扣。
2.余额无法直接购买下载，可以购买VIP、付费专栏及课程。

余额充值