Макет базы данных для работы с FastAPI и Pydantic
Я работаю над проектом, в котором использую FastAPI и pydantic. Об этом упоминалось в репозитории github, из которого я беру задачи: We do expect you to mock a database interaction layer in any way you see fit and generate data (which can be randomized) for the purposes of this test. The implementation of this database layer is left up to you. Ссылка на репозиторий Github: https://github.com/steeleye/recruitment-ext/wiki/API-Developer-Assessment
Я впервые работаю с fastapi и никогда раньше не слышал о насмешках. У меня есть следующий код:
from fastapi import FastAPI, Path
from typing import Optional
from pydantic import BaseModel, Field
import datetime as dt
class TradeDetails(BaseModel):
buySellIndicator: str = Field(description = "A value of BUY for buys, SELL for sells.")
price: float = Field(description = "The price of the Trade.")
quantity: int = Field(description = "The amount of units traded.")
class Trade(BaseModel):
asset_class: Optional[str] = Field(alias = "assetClass", default=None, description = "The asset class of the instrument traded. E.g. Bond, Equity, FX...etc")
counterparty: Optional[str] = Field(default=None, description = "The counterparty the trade was executed with. May not always be available")
instrument_id: str = Field(alias = "instrumentId", description = "The ISIN/ID of the instrument traded. E.g. TSLA, AAPL, AMZN...etc")
instrument_name: str = Field(alias = "instrumentName", description = "The name of the instrument traded.")
trade_date_time: dt.datetime = Field(alias = "tradeDateTime", description = "The date-time the Trade was executed")
trade_details: TradeDetails = Field(alias = "tradeDetails", description = "The details of the trade, i.e. price, quantity")
trade_id: str = Field(alias = "tradeId", default=None, description = "The unique ID of the trade")
trader: str = Field(description = "The name of the Trader")
app = FastAPI()
# data = {
# 'asset_class': 'Bond',
# 'conterparty': 'delio',
# 'instrument_id': 'AAPL',
# 'instrument_name': 'Guitar',
# 'trade_date_time':'2023-06-6 12:22',
# 'trade_details':{'buySellIndicator':'BUY', 'price':100.0, 'quantity': 10},
# 'trade_id': '11',
# 'trader':'john'
# }
trade = Trade(assetClass='asset',
counterparty='count',
instrumentId='AAPL',
instrumentName='Guitar',
tradeDateTime='2023-06-6 12:22',
tradeDetails = {'buySellIndicator':'BUY', 'price':100.0, 'quantity': 10},
tradeId='11',
trader='john')
@app.get("/")
def index():
return {"name": "API Developer Assessment"}
@app.get("/get-trade/{tradeId}")
def get_trade(tradeId:int=Path(description = "The Id of the trade you want to view")):
return trade.tradeId
@app.get("/Trade")
def get_trade_list():
return trade.dict()
# @app.get('/get-by-query')
# def get_trade()
Как мне издеваться над базой данных?
Ответы 1
Скажем, у вас есть эти упрощенные модели:
from typing import Optional
from fastapi import FastAPI, HTTPException
from pydantic import BaseModel, Field
class TradeDetails(BaseModel):
price: float
quantity: int
class Trade(BaseModel):
asset_class: Optional[str] = Field(alias = "assetClass", default=None)
trade_details: TradeDetails = Field(alias = "tradeDetails")
trade_id: str = Field(alias = "tradeId", default=None)
trader: str
...
Точно так же, как @Abhishek предложил в комментарии, вы можете просто настроить очень простой словарь с идентификаторами сделок в качестве ключей и соответствующими объектами Trade в качестве значений, например:
TRADE_1 = Trade(
assetClass = "foo",
tradeDetails=TradeDetails(price=100.0, quantity=10),
tradeId = "1",
trader = "john",
)
TRADE_2 = Trade(
assetClass = "bar",
tradeDetails=TradeDetails(price=200.0, quantity=1),
tradeId = "2",
trader = "alice",
)
TRADE_3 = Trade(
assetClass = "baz",
tradeDetails=TradeDetails(price=3.14, quantity=5),
tradeId = "3",
trader = "dan",
)
MOCK_TRADE_DATABASE = {
"1": TRADE_1,
"2": TRADE_2,
"3": TRADE_3,
}
Затем вы можете настроить свои конечные точки примерно так:
...
app = FastAPI()
@app.get("/trades/{trade_id}")
def get_trade_by_id(trade_id: str) -> Trade:
if trade_id not in MOCK_TRADE_DATABASE:
raise HTTPException(status_code=404)
return MOCK_TRADE_DATABASE[trade_id]
@app.get("/trades/")
def get_trade_list(search: Optional[str] = None) -> list[Trade]:
if search is None:
return list(MOCK_TRADE_DATABASE.values())
# Search only for matching `trader` values:
return [
trade for trade in MOCK_TRADE_DATABASE.values()
if search in trade.trader
]
Если вы попробуете это, вы увидите, что вы можете запросить, например, конкретную сделку 2 через /trades/2, и вы можете получить массив всех сделок, где trader имеет a в своем имени через /trades/?search=a.
Если вы хотите немного пофантазировать, вы можете вместо этого настроить простую базу данных SQLite и даже разрешить пользователям добавлять в нее новые Trade.
Но поскольку в задании четко сказано «издеваться» над базой данных, я не думаю, что настоящая база данных (даже такая минимальная, как SQLite) ожидается.
Могу ли я искать что-нибудь? с помощью второй конечной точки?
@KarthikBhandary Хочешь, я решу за тебя все задание?
Нет, я разобрался! Я просто не увидел комментарий, прежде чем спросить
Я тоже выполнил задание. Спасибо вам за помощь!
почему бы не использовать объект
dictизTradeсidв качестве ключа и вставить в него кучу объектов (может быть случайным) и получить от него при вызове API.