快捷導(dǎo)航

一文搞定FastAPI中的查詢參數(shù)

更新時(shí)間：2024年03月27日 10:12:32 作者：shengjk1

FastAPI中最核心的之一就是路徑參數(shù),所以這篇文章小編主要來(lái)和大家介紹一下FastAPI查詢參數(shù)的作用以及基本使用,有需要的小伙伴可以參考下

一、查詢參數(shù)定義

路徑操作函數(shù)中，不是路徑參數(shù)的其他參數(shù)，就是查詢參數(shù)。比如：

from fastapi import FastAPI

app = FastAPI()

@app.get( "/items" )
def read_item(item_id:int,item_name:str):
    return { "item_id" : item_id,"item_name":item_name}
     
    
if __name__ == "__main__" :
    import uvicorn
    uvicorn.run( "quickstart.demo:app" ,reload=True ,port= 8001)

item_id，item_name 都不是路徑參數(shù)，所以它就是查詢參數(shù)。

二、查詢參數(shù)作用

方便給路徑操作函數(shù) 傳參

三、查詢參數(shù)基本使用

3.1. URL拼接和必需參數(shù)

查詢參數(shù)，一般是在 URL 的 ? 后，并以 & 分割，比如：

from fastapi import FastAPI

app = FastAPI()

@app.get( "/items" )
def read_item(item_id:int,item_name:str):
    return { "item_id" : item_id,"item_name":item_name}
     
    
if __name__ == "__main__" :
    import uvicorn
    uvicorn.run( "quickstart.demo:app" ,reload=True ,port= 8001)

此時(shí) item_id 和 item_name 都是必需的，URL必須傳這兩個(gè)參數(shù)。啟動(dòng)程序，然后在瀏覽器中訪問(wèn) http://127.0.0.1:8001/items?item_id=1&item_name=xiaoming，響應(yīng)為：

{"item_id":1,"item_name":"xiaoming"}

3.2. 默認(rèn)值

查詢參數(shù)可以設(shè)置默認(rèn)值，如：item_name 默認(rèn)值為 xiaoming

from fastapi import FastAPI

app = FastAPI()

@app.get( "/items" )
def read_item(item_id:int,item_name:str='xiaoming'):
    return { "item_id" : item_id,"item_name":item_name}
     
    
if __name__ == "__main__" :
    import uvicorn
    uvicorn.run( "quickstart.demo:app" ,reload=True ,port= 8001)

訪問(wèn) http://127.0.0.1:8001/items?item_id=1&item_name=xiaoming 和訪問(wèn) http://127.0.0.1:8001/items?item_id=1 他們的結(jié)果都是一樣的。因?yàn)閁RL 中不設(shè)置 item_name 的值，它會(huì)用默認(rèn)值來(lái)填充。

3.3. 可選參數(shù)

查詢參數(shù)可以設(shè)置為可選參數(shù)，如 item_name=None 可選參數(shù)的意思：URL中可以不包含這個(gè)參數(shù)，屬于可有可無(wú)

from fastapi import FastAPI

app = FastAPI()

@app.get( "/items" )
def read_item(item_id:int,item_name:str=None):
    if item_name:
        return { "item_id" : item_id,"item_name":item_name}
    else:
        return { "item_id" : item_id}
     
    
if __name__ == "__main__" :
    import uvicorn
    uvicorn.run( "quickstart.demo:app" ,reload=True ,port= 8001)

訪問(wèn) http://127.0.0.1:8001/items?item_id=1&item_name=xiaoming 響應(yīng)為：

{"item_id":1,"item_name":"xiaoming"}

和訪問(wèn) http://127.0.0.1:8001/items?item_id=1 響應(yīng)為：

{"item_id":1}

3.4. Pydantic 模型( 請(qǐng)求體 )作為查詢參數(shù)

from fastapi import FastAPI
from pydantic import BaseModel

app = FastAPI()

class Item(BaseModel):
    name: str
    price: float
    
@app.put( "/items/{item_id}" )
def  put_item(item_id:int,item:Item):
    return { "item_id" : item_id, "item" :item}

if __name__ == "__main__" :
    import uvicorn
    uvicorn.run( "quickstart.demo:app" , reload=True, port=8001)

Client端：

import requests

data={ "name" : "flow" , "price" :2.3}

respone=requests.put( "http://127.0.0.1:8001/items/1" ,json=data)
print(respone.json())

respone的結(jié)果：

{'item_id': 1, 'item': {'name': 'flow', 'price': 2.3}}

三、總結(jié)

本文詳細(xì)介紹了查詢參數(shù)在FastAPI中的基本使用方法，包括URL拼接和必需參數(shù)、默認(rèn)值、可選參數(shù)和Pydantic模型作為查詢參數(shù)的使用。通過(guò)這些方法，可以靈活地處理和傳遞查詢參數(shù)，實(shí)現(xiàn)更豐富的功能需求。

到此這篇關(guān)于一文搞定FastAPI中的查詢參數(shù)的文章就介紹到這了,更多相關(guān)FastAPI查詢參數(shù)內(nèi)容請(qǐng)搜索腳本之家以前的文章或繼續(xù)瀏覽下面的相關(guān)文章希望大家以后多多支持腳本之家！

您可能感興趣的文章: