FastAPI上手指南（三）：路径参数和查询参数

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

app = FastAPI()

@app.get("/test/xx")
async def read_item_me():
    return {"me": 'me'}

@app.get("/test/{item_id}")
async def read_item(item_id: str):
    return {"item_id": item_id}

@app.get("/")
async def main():
    return {"message": "Hello，FastAPI"}
    
if __name__ == '__main__':
    import uvicorn
   uvicorn.run(app='params1:app', host="127.0.0.1", port=8000, reload=True, debug=True)

一、几种参数请求类型

1.无参get请求

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

@app.get("/")就是路由路径配置，目录为根目录，方法为get，调用函数为main。

在docs里调试为
与上面类似的
@app.get("/test/xx")
async def read_item_me():
    return {"me": 'me'}

该路由路径为/test/xx，方法get，返回一个json。

2.路径参数

@app.get("/test/{item_id}")
async def read_item(item_id: str):
    return {"item_id": item_id}

该路由有路径参数item_id，同时函数参数中也声明item_id，并且指定他的参数类型为str。


参数类型限制，如果我把

@app.get("/test/{item_id}")
async def read_item(item_id: str):
    return {"item_id": item_id}

改为

@app.get("/test/{item_id}")
async def read_item(item_id: int):
    return {"item_id": item_id}

则参数就只能是数字不能是其他类型


如果输入string，float等非int类型会报错提示


3.查询参数

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

app = FastAPI()

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]
    
if __name__ == '__main__':
   uvicorn.run(app='params1:app', host="127.0.0.1", port=8000, reload=True, debug=True)
image.png

http://127.0.0.1:8000/items/?skip=0&limit=2

其中?后面的skip=0&limit=2就是查询参数

4.多路径和查询参数

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

app = FastAPI()

@app.get("/users/{user_id}/items/{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
    
if __name__ == '__main__':
   uvicorn.run(app='params1:app', host="127.0.0.1", port=8000, reload=True, debug=True)

async def read_user_item(
    user_id: int, item_id: str, q: str = None, short: bool = False
):

函数的参数user_id和item_id是路径参数，是必须的。
q：str=None 意思是非必需的。
如果没有q，short为ture那么只返回user_id和item_id



问号？之后多个查询参数之间用&连接


二、路径参数和查询参数的选项

1.必选和非必选参数

参数的可选和必选主要是通过是否给默认值来决定的：

@app.get("/items/{item_id}")
async def read_user_item(item_id: str):
    item = {"item_id": item_id}
    return item

@app.get("/items/{item_id}")
async def read_user_item(item_id: str, needy: str):
    item = {"item_id": item_id, "needy": needy}
    return item

上述的代码中 needy 没有给与默认的值，当个没提交这个值的时候，会提示错误：

再例如

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

A没有默认值，B,C有默认值，所以A是必须有的，BC可以没有




2.限制参数的类型

上面也说道过，在函数参数后面声明参数的类型，可以指定参数类型

3.限制参数的长度

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

app = FastAPI()

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

if __name__ == '__main__':
   uvicorn.run(app='params1:app', host="127.0.0.1", port=8000, reload=True, debug=True)

q为查询路径，填None就是默认值 填 ...则是必填项，min_length，max_length规定长度，如果超出长度范围就会报错


4.正则表达式

@app.get("/items/")
async def read_items(q: str = Query(None, min_length=3, max_length=50, regex="^fast")):
    results = {"items": [{"item_id": "Foo"}, {"item_id": "Bar"}]}
    if q:
        results.update({"q": q})
    return results

参数q只允许开头是fast才行

当然因为q参数为None非必须，不传他也行

4，参数是列表

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

5.弃用参数

#弃用参数
@app.get("/items5/")
async def read_items5(
    q: str = Query(
        None,
        description="Query",
        min_length=3,
        max_length=50,
        regex="^fast",
        deprecated=True,
    )
):
    results = {"items": [{"item_id": "Foo"}, {"item_id": "Bar"}]}
    if q:
        results.update({"q": q})
    return results

deprecated=True,该参数无法使用


三，路径参数的枚举

# -*- coding: UTF-8 -*-
from fastapi import FastAPI, Query
from typing import List
from enum import Enum
import uvicorn

app = FastAPI()

class Language(str, Enum):
    go   = 'Golang'
    py   = 'Python'
    cpp  = 'C++'
    ts   = 'Typescript'

app = FastAPI()

@app.get("/{language}")
async def get_day(language: Language):
    if language == Language.go:
        return {"language": language, "message": "gogogogogo,"}
    if language.value == 'Python':
        return {"language": language, "message": "pypypypy"}
    if language.value == 'Typescript':
        return {"language": language, "message": "tststststs"}
    if language.value == 'C++':
        return {"language": language, "message": "C++C++C++"}
    return {"message": "error"}

if __name__ == '__main__':
   uvicorn.run(app='params1:app', host="127.0.0.1", port=8000, reload=True, debug=True)

image.png
最后编辑于 ：
©著作权归作者所有,转载或内容合作请联系作者
  • 人面猴
    序言：七十年代末，一起剥皮案震惊了整个滨河市，随后出现的几起案子，更是在滨河造成了极大的恐慌，老刑警刘岩，带你破解...
    沈念sama阅读 220,367评论 6赞 512
  • 死咒
    序言：滨河连续发生了三起死亡事件，死亡现场离奇诡异，居然都是意外死亡，警方通过查阅死者的电脑和手机，发现死者居然都...
    沈念sama阅读 93,959评论 3赞 396
  • 救了他两次的神仙让他今天三更去死
    文/潘晓璐 我一进店门，熙熙楼的掌柜王于贵愁眉苦脸地迎上来，“玉大人，你说我怎么就摊上这事。” “怎么了？”我有些...
    开封第一讲书人阅读 166,750评论 0赞 357
  • 道士缉凶录：失踪的卖姜人
    文/不坏的土叔 我叫张陵，是天一观的道长。 经常有香客问我，道长，这世上最难降的妖魔是什么？ 我笑而不...
    开封第一讲书人阅读 59,226评论 1赞 295
  • 港岛之恋（遗憾婚礼）
    正文 为了忘掉前任，我火速办了婚礼，结果婚礼上，老公的妹妹穿的比我还像新娘。我一直安慰自己，他们只是感情好，可当我...
    茶点故事阅读 68,252评论 6赞 397
  • 恶毒庶女顶嫁案：这布局不是一般人想出来的
    文/花漫 我一把揭开白布。 她就那样静静地躺着，像睡着了一般。 火红的嫁衣衬着肌肤如雪。 梳的纹丝不乱的头发上，一...
    开封第一讲书人阅读 51,975评论 1赞 308
  • 城市分裂传说
    那天，我揣着相机与录音，去河边找鬼。 笑死，一个胖子当着我的面吹牛，可吹牛的内容都是我干的。 我是一名探鬼主播，决...
    沈念sama阅读 40,592评论 3赞 420
  • 双鸳鸯连环套：你想象不到人心有多黑
    文/苍兰香墨 我猛地睁开眼，长吁一口气：“原来是场噩梦啊……” “哼！你这毒妇竟也来了？” 一声冷哼从身侧响起，我...
    开封第一讲书人阅读 39,497评论 0赞 276
  • 万荣杀人案实录
    序言：老挝万荣一对情侣失踪，失踪者是张志新（化名）和其女友刘颖，没想到半个月后，有当地人在树林里发现了一具尸体，经...
    沈念sama阅读 46,027评论 1赞 319
  • 护林员之死
    正文 独居荒郊野岭守林人离奇死亡，尸身上长有42处带血的脓包…… 初始之章·张勋 以下内容为张勋视角 年9月15日...
    茶点故事阅读 38,147评论 3赞 340
  • 白月光启示录
    正文 我和宋清朗相恋三年，在试婚纱的时候发现自己被绿了。 大学时的朋友给我发了我未婚夫和他白月光在一起吃饭的照片。...
    茶点故事阅读 40,274评论 1赞 352
  • 活死人
    序言：一个原本活蹦乱跳的男人离奇死亡，死状恐怖，灵堂内的尸体忽然破棺而出，到底是诈尸还是另有隐情，我是刑警宁泽，带...
    沈念sama阅读 35,953评论 5赞 347
  • 日本核电站爆炸内幕
    正文 年R本政府宣布，位于F岛的核电站，受9级特大地震影响，放射性物质发生泄漏。R本人自食恶果不足惜，却给世界环境...
    茶点故事阅读 41,623评论 3赞 331
  • 男人毒药：我在死后第九天来索命
    文/蒙蒙 一、第九天 我趴在偏房一处隐蔽的房顶上张望。 院中可真热闹，春花似锦、人声如沸。这庄子的主人今日做“春日...
    开封第一讲书人阅读 32,143评论 0赞 23
  • 一桩弑父案，背后竟有这般阴谋
    文/苍兰香墨 我抬头看了看天上的太阳。三九已至，却和暖如春，着一层夹袄步出监牢的瞬间，已是汗流浃背。 一阵脚步声响...
    开封第一讲书人阅读 33,260评论 1赞 272
  • 情欲美人皮
    我被黑心中介骗来泰国打工， 没想到刚下飞机就差点儿被人妖公主榨干…… 1. 我叫王不留，地道东北人。 一个月前我还...
    沈念sama阅读 48,607评论 3赞 375
  • 代替公主和亲
    正文 我出身青楼，却偏偏与公主长得像，于是被迫代替她去往敌国和亲。 传闻我的和亲对象是个残疾皇子，可洞房花烛夜当晚...
    茶点故事阅读 45,271评论 2赞 358