FastAPI 2 - URL 请求及参数

已于 2023-07-27 14:40:55 修改
阅读量4.1k 收藏 2
点赞数
分类专栏： # Python 文章标签： FastAPI Query Request Body
于 2021-11-28 16:24:19 首次发布
原文链接：https://www.bilibili.com/video/BV1sE411x7bi
版权
本文深入探讨了FastAPI中的URL请求及参数处理，包括路径参数、查询参数（枚举、数据类型、长度限制、正则、列表等）、查询参数验证、路径参数与数值验证、Cookie和Header参数的使用。通过实例展示了如何实现各种参数验证和请求处理。

摘要生成于 C知道 ，由 DeepSeek-R1 满血版支持， 前往体验 >

路径参数

文章目录

学习自 https://www.bilibili.com/video/BV1sE411x7bi

在教程基础上，增加了 requests 请求。

一、URL 请求

No.7

# -*- coding: UTF-8 -*-
from fastapi import FastAPI

app = FastAPI()

@app.get("/me/xx")
async def read_item_me():
    return {"me": 'me'}
'''
访问 http://127.0.0.1:8000/me/xx
返回 {"me":"me"}
'''

@app.get("/me/{item_id}")
async def read_item(item_id: str):
    return {"item_id": item_id}
'''
http://127.0.0.1:8000/me/123
{"item_id":"123"}
'''

@app.get("/")
async def main():
    return {"message": "Hello，FastAPI"}
    
'''
访问 http://127.0.0.1:8000/
返回 {"message":"Hello，FastAPI"}
'''
   
if __name__ == '__main__':
    import uvicorn
    uvicorn.run(app, host="127.0.0.1", port=8001)

使用枚举 Enum

from enum import Enum

class Name(str, Enum):
    Allan = '张三'
    Jon   = '李四'
    Bob   = '王五'

app = FastAPI()


@app.get("/{who}")
async def get_day(who: Name):
    if who == Name.Allan:
        return {"who": who, "message": "张三是德国人"}
    if who.value == '李四':
        return {"who": who, "message": "李四是英国人"}
    return {"who": who, "message": "王五是法国人"}

'''
访问 http://127.0.0.1:8001/%E5%BC%A0%E4%B8%89 （张三）
{"who":"张三","message":"张三是德国人"}


访问 http://127.0.0.1:8001/%E6%9D%8E%E5%9B%9B  ( http://127.0.0.1:8001/李四 )
返回 {"who":"李四","message":"李四是英国人"}

访问 http://127.0.0.1:8001/Allan
返回 {"detail":[{"loc":["path","who"],"msg":"value is not a valid enumeration member; permitted: '张三', '李四', '王五'","type":"type_error.enum","ctx":{"enum_values":["张三","李四","王五"]}}]}
'''

@app.get("/")
async def main():
    return {"message": "Hello，FastAPI2"}

'''
访问 http://127.0.0.1:8000/
返回 {"message":"Hello，FastAPI2"}
'''

二、查询参数 Query Parameters

No.8

传递不同数据类型

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]

'''
访问 http://127.0.0.1:8000/items/  
页面显示 [{"item_name":"Foo"},{"item_name":"Bar"},{"item_name":"Baz"}]

访问 http://127.0.0.1:8000/items/?skip=1&limit=2
页面显示：[{"item_name":"Bar"},{"item_name":"Baz"}]
'''
   

@app.get("/i/")
async def i(A: str = 'HI..', B: str = 'Hello..', C: str = 'He..'):
    return {'cc': A+B+C},{'dd': B+C}

'''
http://127.0.0.1:8000/i/
[{"cc":"HI..Hello..He.."},{"dd":"Hello..He.."}]

http://127.0.0.1:8000/i/?A=Sun
[{"cc":"SunHello..He.."},{"dd":"Hello..He.."}]

http://127.0.0.1:8000/i/?A=Sun..&C=Rain...
[{"cc":"Sun..Hello..Rain..."},{"dd":"Hello..Rain..."}]
'''


    
@app.get("/ii/")
async def ii(A: int = 0, B: int = 10, C: int = 20):
    return {'cc': A+B+C},{'dd': B+C}

@app.get("/iii/")
async def iii(A: int = 0, B: int = 10, C: int = 20):
    return 'A+B+C',A+B+C

'''
http://127.0.0.1:8000/iii/
"A+B+C",30]
'''
   
# bool与类型转换
@app.get("/xxx/{item_id}")
async def xxx(item_id: str, QQ: str = None, SS: bool = False):
    item = {"item_id": item_id}
    if QQ:
        item.update({"QQ": QQ})
    if not SS:  # 如果SS是假
        item.update(
            {"item_id": "This is SSSSSSS"}
        )
    return item

'''
# 传入的是路径，而非参数，所以不使用 ？ 
http://127.0.0.1:8000/xxx/123
{"item_id":"This is SSSSSSS"}

http://127.0.0.1:8000/xxx/123?QQ=SUN&SS=True
{"item_id":"123","QQ":"SUN"}
'''

多路径 和 查询参数 和 必填字段


 

#多路径 和 查询参数 和 必填字段
@app.get("/user/{user_id}/item/{item_id}")
async def read_user_item(
    user_id: int, item_id: str, q: 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
'''
http://127.0.0.1:8000/user/1/item/2
{"item_id":"2","owner_id":1,"description":"This is an amazing item that has a long description"}

? 接参数，应该放最后面，而不是放在 user_id 之后 中间的位置
比如 http://127.0.0.1:8000/user/1?q=1/item/2  不对

http://127.0.0.1:8000/user/1/item/2?q=2 正确
返回  {"item_id":"2","owner_id":1,"q":"2","description":"This is an amazing item that has a long description"}
 
'''

三、查询参数和字符验证 Query Validations

No.10

1、长度限制


from fastapi import FastAPI, Query
from typing import List


# 限制长度
@app.get("/items/")
async def read_items(q: str = Query(..., min_length=3, max_length=50)):    
    #填None就是默认值   填 ...则是必填项 
    results = {"items": [{"item_id": "Foo"}, {"item_id": "Bar"}]}
    if q:
        results.update({"q": q})
    return results

'''
... 代表什么都没有，None 代表这里有东西，只是是 None
q: str = Query(..., min_length=3, max_length=50) 这样写，q 不是必填项
q: str = Query(None, min_length=3, max_length=50) 这样写，q 是必填项
 
'''

测试请求


import requests

def test1():
    
    item_id = 5
    q = 'qaqa'
    url = f'http://127.0.0.1:8000/items/?q={q}'
    # url = f'http://127.0.0.1:8000/items/'  
    ret = requests.get(url=url, timeout=10)
    print('ret 0 : ', ret)  # ret 0 :  <Response [200]>
    print('ret 1 : ', ret.text)
    # {"items":[{"item_id":"Foo"},{"item_id":"Bar"}],"q":"qaqa"}

    # 
    '''
    q 是必填项
    如果请求 http://127.0.0.1:8000/items/，返回 {"detail":[{"loc":["query","q"],"msg":"field required","type":"value_error.missing"}]}  

    如果 q = 'qa'， 小于三位，则返回：
    {"detail":[{"loc":["query","q"],"msg":"ensure this value has at least 3 characters","type":"value_error.any_str.min_length","ctx":{"limit_value":3}}]}

    '''

2、正则


#正则表达式
@app.get("/items2/")
async def read_items2(
                        q: str = Query(None, min_length=3, max_length=50, regex="^nice")
                     ):
    results = {"items": [{"item_id": "Foo"}, {"item_id": "Bar"}]}
    if q:
        results.update({"q": q})
    return results

'''
q = 'nice to meet you'
url = f'http://127.0.0.1:8000/items2/?q={q}'
#  {"items":[{"item_id":"Foo"},{"item_id":"Bar"}],"q":"nice to meet you"}

q 需要匹配正则 ^nice
'''

3、列表

#列表
@app.get("/items3/")
async def read_items3(q: List[str] = Query(["foo", "bar"])):
    query_items = {"q": q}
    return query_items

'''
列表的默认值为 ["foo", "bar"]

request :  http://127.0.0.1:8002/items3/?q=foo&q=bar 
ret 1 :  {"q":["foo","bar"]}


request :  http://127.0.0.1:8002/items3/?q=foo 
ret 1 :  {"q":["foo"]}


request :  http://127.0.0.1:8000/items3/?q=['foo', 'bar']
Read timed out.


'''

请求

def test3():
    
    item_id = 5
    q = ['1', 'a']
    q = [ "foo", "bar" ]
    url = f'http://127.0.0.1:8000/items3/?q={q}'
    # url = f'http://127.0.0.1:8000/items/' 
    print('request : ', url) 
    ret = requests.get(url=url, timeout=10)
    print('ret 0 : ', ret)  # ret 0 :  <Response [200]>
    print('ret 1 : ', ret.text)
    # {"q":["['1', 'a']"]}
    # {"q":["['foo', 'bar']"]}
    # 如果不输入q，返回 {"q":["foo","bar"]}

4、别名参数

#别名参数
@app.get("/items4/")
async def read_items4(q: str = Query(None, alias="item-query")):
    results = {"items": [{"item_id": "Foo"}, {"item_id": "Bar"}]}
    if q:
        results.update({"q": q})
    return results

'''
使用别名 alias 查询
request :  http://127.0.0.1:8002/items4/?item-query=fish 
ret 1 :  {"items":[{"item_id":"Foo"},{"item_id":"Bar"}],"q":"fish"}

# 使用 q 来查询，没有效果；
request :  http://127.0.0.1:8002/items4/?q=fish 
ret 1 :  {"items":[{"item_id":"Foo"},{"item_id":"Bar"}]}
'''

5、弃用参数

#弃用参数
@app.get("/items5/")
async def read_items5(
    q: str = Query(
        None,
        alias="item-query",
        title="Query string",
        description="Query string for the items to search in the database that have a good match",
        min_length=3,
        max_length=50,
        regex="^fixedquery$",
        deprecated=True,
    )
):
    results = {"items": [{"item_id": "Foo"}, {"item_id": "Bar"}]}
    if q:
        results.update({"q": q})
    return results

'''


'''

四、路径参数与数值验证

No.11


from fastapi import FastAPI, Path, Query

app = FastAPI() 

@app.get("/items/{item_id}")
async def read_items(
    item_id: int = Path(..., title="The ID of the item to get", ge=50, le=100),#ge 大于等于 gt是大于 le是小于等于
    q: str       = Query(None, alias="item-query"),
    size: float  = Query(1, gt=0, lt=10.5)
                    ):
    results = {"item_id": item_id}
    if q:
        results.update({"q": q})
    return results
'''
request :  http://127.0.0.1:8004/items/12
ret 0 :  <Response [422]>
ret 1 :  {"detail":[{"loc":["path","item_id"],"msg":"ensure this value is greater than or equal to 50","type":"value_error.number.not_ge","ctx":{"limit_value":50}}]}

request :  http://127.0.0.1:8004/items/65 
ret 1 :  {"item_id":65}
'''

五、Cookie Parameters

No.16

# -*- coding: UTF-8 -*-
from fastapi import Cookie, FastAPI

app = FastAPI()


@app.get("/items/")
async def read_items(*, ads_id: str = Cookie(None)):
    return {"ads_id": ads_id}
 
if __name__ == '__main__':
    import uvicorn
    uvicorn.run(app, host="127.0.0.1", port=8000)

def test1():
     
    url = 'http://127.0.0.1:8000/items/' 

    headers = {'Cookie':'ads_id=100'}     
    headers = {'Cookie':'ads_id=100;ads_id=199'}  # 多个赋值之间用分号;而非逗号隔开；相同键取最后一个赋值。

    print('request : ', url) 
    ret = requests.get(url=url, headers=headers, timeout=10)
    print('ret 0 : ', ret)  
    print('ret 1 : ', ret.text) # {"ads_id":"199"}

六、Head Patameters

No.17

from fastapi import FastAPI, Header
from typing import List
app = FastAPI()


@app.get("/items/")
async def read_items(*, user_agent: str = Header(None), users_agent: str = Header(None)):
    return  {"User-Agent": user_agent},{"AAAAA": user_agent},{'ABCD': users_agent}
            
@app.get("/items2/")
async def read_items2(x_token: List[str] = Header(None)):
    return {"X-Token values": x_token}
    

def test2():
     
    url = 'http://127.0.0.1:8000/items/' 

    headers = {'user_agent':'a1', 
                'User-Agent':'a2', 
                'users_agent':'a3'}     

    print('request : ', url) 
    ret = requests.get(url=url, headers=headers, timeout=10)
    print('ret 0 : ', ret)  
    print('ret 1 : ', ret.text)  #  [{"User-Agent":"a2"},{"AAAAA":"a2"},{"ABCD":null}]

def test2(): 
    url = 'http://127.0.0.1:8000/items2/'  
    headers = {'x-token':['b1', 'b2', 'b3'] } # 报错  Value for header {x-token: ['b1', 'b2', 'b3']} must be of type str or bytes, not <class 'list'> 
    headers = {'x-token':'b1,b2,b3' }     
    print('request : ', url) 
    ret = requests.get(url=url, headers=headers, timeout=10)
    print('ret 0 : ', ret)  
    print('ret 1 : ', ret.text) #  {"X-Token values":["b1,b2,b3"]}

伊织 2021-11-28

FastAPI 5 - 常用请求及 postman、curl 使用（parameters，x-www-form-urlencoded, raw）
AI工程化、开源分享、文档翻译、代码笔记
06-10 3254
fastapi 请求接口的不同方法，配合 postman 测试，curl 命令、requests 请求 get parameters body - form-data x-www-form-urlencoded raw
python系列：FASTAPI 03-带参数的URL请求
weixin_54626591的博客
06-03 618
FASTAPI 03-带参数的URL请求
FASTAPI 03-带参数的URL请求
lzq599220的博客
03-11 1322
实例阐述了FastAPI框架下如何便捷、严格地处理URL路径参数，并利用自动化的API文档增强接口使用的可理解和可测试性。
FastAPI从入门到实战(16)——请求参数汇总
tangsiqi130的博客
04-25 682
FastAPI从入门到实战(16)——请求参数汇总
Python FastApi（2）：基础使用
最新发布
游王子og的博客
03-21 655
进入文件所在目录，运行实时服务器。TestTest.pyappTest.py--reload打开浏览器访问。
fastapi 获取url参数
十一的博客
06-24 1451
fastapi 获取URL参数
【FastApi】 url参数
weixin_42914989的博客
11-11 937
路径参数是直接在 URL 路径中定义的参数，它们是 URL 的一部分。FastAPI 会自动将 URL 中匹配的部分映射到对应的路径参数。查询参数是 URL 中路径后面?开始的键值对，通常用于过滤、分页等操作。FastAPI 会将查询参数作为函数参数传递，方便获取。
【大模型应用开发-FastAPI框架】(二)FastAPI接收URL参数
04-04 402
参考。FastAPI 是一个高性能、易用且现代的 Python Web 框架，它通过使用最新的 Python 特性和异步编程，提供了快速开发 Web API 的能力。该框架不仅易于学习和使用，还具有自动生成文档、数据验证等强大功能。无论是构建小型项目还是大型应用程序，FastAPI 都是一个强大而有效的工具。 现在你已经了解了 FastAPI 的概念和使用方法，你可以访问官方网站并尝试使用 FastAPI 来构建自己的 Web 应用程序。
FastAPI-url参数: 路径参数
weixin_46344889的博客
11-13 260
POST和PUT向服务器提交数据，其中POST不具备幂等性，而PUT具有幂等性。举个例子，我用POST请求向服务器添加{‘name’:'misaka'}, 多向服务器请求三次，服务器里可能就会有{{‘name’:'misaka'},{‘name’:'misaka'},{‘name’:'misaka'}}。在这里，引入一个幂等性的概念，即相同的操作（请求）不论做多少次，最终的结果都是相同的。它提供了['GET', 'POST', 'DELETE', 'PUT']的请求接口，那么这些接口有什么作用和区别呢？
fastapi参数-请求操作、参数、函数
u010428264的专栏
08-21 220
安装fastapi：pip install "fastapi[all]"运行命令：uvicorn main:app --reloadmainmain.pyappmain.py--reload运行后可查看api文档。
python系列（亲测有效）：FASTAPI系列 08-POST请求多参数
weixin_54626591的博客
06-03 728
FASTAPI系列 08-POST请求多参数
fastapi获取请求参数
m0_38010072的博客
02-12 4942
title: fastapi获取请求参数 date: 2021-11-29 00:33:01 GET 代码： from fastapi import FastAPI, Request import uvicorn import time import requests ​ app = FastAPI() ​ @app.get("/test") def test(parameter: str = ''): rdat = "default" if parameter != "": ...
FastAPI学习-2.url 上的路径参数
qq_27371025的博客
03-06 818
前言 在开发restful接口的时候，会遇到接口路径带参数的情况，比如 查询单个 book 接口：get /api/v1/book/{id} 修改单个 book 接口：put /api/v1/book/{id} 删除单个 book 接口: delete /api/v1/book/{id} 这里路径里面的 {id} 就是路径参数 简单示例 可以使用与 Python 格式化字符串相同的语法来声明路径"参数"或"变量 from fastapi import FastAPI app = FastAPI()
url请求
weixin_30528371的博客
06-02 328
--[[local g = require 'library.global'--__ml_ss = mlc.prefix.ml_psession..tostring(os.time());local mlc = require 'ml_config' local function haslogin() local r = g.getredis() local s,e = r:get();...
URL请求
weixin_42761571的博客
02-12 423
1.得到URL对象 URL url = new URL(“url”); 2.打开连接 HttpUrlConnection con = (HttpURLConnection) url.openConnection(); 3.设置提交方式,编码方式 con.setRequestMethod(“POST”); con.setRequestProperty(“Content-Type”, “appli...
fastapi_No.3_获取请求中的参数
Ethan's Blog
10-13 1209
FastAPI中获取路径参数，查询参数和请求体参数的方法。
URLRequest 请求参数设置
chenxiaohong的专栏
03-30 994
[code="flex"] var request:URLRequest = new URLRequest("http://"); request.method = URLRequestMethod.GET or URLRequestMethod.POST; //请求方式 var variables: URLVariables = new URLVariables(); variables...
获取请求url中的参数
weixin_30398227的博客
09-13 778
一、根据request获取参数 假设请求地址是： http://127.0.0.1:8020/books/?title=语文 那么后台的路由配置： re_path('books/$', views.BookView.as_view(), name="books") 视图中通过request获取参数title： title = request.Get.ge...
获取 url 路径上的请求参数
zzvar的博客
07-08 2277
//获取url上的请求参数 function getParams() { //获取问号及问号后面的内容 var url = window.location.search; var params = new Object(); // 判断是否有参数 if (url.indexOf("?") != -1) { //截取问号后面的内容,再使用&分割多个属性 var arr = url.substr(1).split("&");
fastapi strict-origin-when-cross-origin
02-10
### 配置 FastAPI 中的 `strict-origin-when-cross-origin` CORS 设置 为了配置 FastAPI 应用程序中的 `strict-origin-when-cross-origin` 跨域资源共享 (CORS)，可以利用 FastAPI 提供的强大中间件功能来实现这一点。具体来说，通过自定义 `CORSMiddleware` 的参数能够满足这一需求。 下面是一个具体的例子展示如何设置： ```python from fastapi import FastAPI from fastapi.middleware.cors import CORSMiddleware app = FastAPI() origins = [ "http://localhost", "http://localhost:8080", ] app.add_middleware( CORSMiddleware, allow_origins=origins, allow_credentials=True, allow_methods=["*"], allow_headers=["*"], expose_headers=['Content-Type', 'Authorization'], ) @app.get("/") async def main(): return {"message": "Hello World"} ``` 上述代码片段展示了基本的 CORS 配置方法[^1]。然而要特别针对 `strict-origin-when-cross-origin` 进行配置，则需要进一步调整响应头以确保当请求来自不同源时只返回原始站点地址作为Referer值；而同源情况下则保持完整的URL路径不变。这可以通过修改服务器端发送给客户端的特定HTTP头部字段完成，在FastAPI中可通过扩展现有的中间件逻辑或创建新的依赖项注入器来达成目的。 对于更复杂的场景，如果希望严格控制跨站请求的安全策略并遵循 `strict-origin-when-cross-origin` 行为模式，建议深入研究官方文档以及相关RFC标准文件获取更多信息[^2]。
评论
添加红包

请填写红包祝福语或标题

个

红包个数最小为10个

元

红包金额最低5元

当前余额3.43元 前往充值 >
需支付：10.00元
成就一亿技术人!
领取后你会自动成为博主和红包主的粉丝 规则
hope_wisdom
发出的红包
实付元
使用余额支付
点击重新获取
扫码支付
钱包余额 0

抵扣说明：

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

余额充值