126 lines
3.7 KiB
Markdown
126 lines
3.7 KiB
Markdown
|
|
The use of ormar with fastapi is quite simple.
|
|
|
|
Apart from connecting to databases at startup everything else
|
|
you need to do is substitute pydantic models with ormar models.
|
|
|
|
Here you can find a very simple sample application code.
|
|
|
|
```python
|
|
from typing import List
|
|
|
|
import databases
|
|
import pytest
|
|
import sqlalchemy
|
|
from fastapi import FastAPI
|
|
from starlette.testclient import TestClient
|
|
|
|
import ormar
|
|
from tests.settings import DATABASE_URL
|
|
|
|
app = FastAPI()
|
|
metadata = sqlalchemy.MetaData()
|
|
database = databases.Database(DATABASE_URL, force_rollback=True)
|
|
app.state.database = database
|
|
|
|
# define startup and shutdown events
|
|
@app.on_event("startup")
|
|
async def startup() -> None:
|
|
database_ = app.state.database
|
|
if not database_.is_connected:
|
|
await database_.connect()
|
|
|
|
|
|
@app.on_event("shutdown")
|
|
async def shutdown() -> None:
|
|
database_ = app.state.database
|
|
if database_.is_connected:
|
|
await database_.disconnect()
|
|
|
|
# define ormar models
|
|
class Category(ormar.Model):
|
|
class Meta:
|
|
tablename = "categories"
|
|
metadata = metadata
|
|
database = database
|
|
|
|
id: ormar.Integer(primary_key=True)
|
|
name: ormar.String(max_length=100)
|
|
|
|
|
|
class Item(ormar.Model):
|
|
class Meta:
|
|
tablename = "items"
|
|
metadata = metadata
|
|
database = database
|
|
|
|
id: ormar.Integer(primary_key=True)
|
|
name: ormar.String(max_length=100)
|
|
category: ormar.ForeignKey(Category, nullable=True)
|
|
|
|
# define endpoints in fastapi
|
|
@app.get("/items/", response_model=List[Item])
|
|
async def get_items():
|
|
items = await Item.objects.select_related("category").all()
|
|
# not that you can return a model directly - fastapi will json-ize it
|
|
return items
|
|
|
|
|
|
@app.post("/items/", response_model=Item)
|
|
async def create_item(item: Item):
|
|
# note how ormar methods like save() are available streight out of the box
|
|
await item.save()
|
|
return item
|
|
|
|
|
|
@app.post("/categories/", response_model=Category)
|
|
async def create_category(category: Category):
|
|
await category.save()
|
|
return category
|
|
|
|
|
|
@app.put("/items/{item_id}")
|
|
async def get_item(item_id: int, item: Item):
|
|
# you can work both with item_id or item
|
|
item_db = await Item.objects.get(pk=item_id)
|
|
return await item_db.update(**item.dict())
|
|
|
|
|
|
@app.delete("/items/{item_id}")
|
|
async def delete_item(item_id: int, item: Item):
|
|
item_db = await Item.objects.get(pk=item_id)
|
|
return {"deleted_rows": await item_db.delete()}
|
|
|
|
# here is a sample test to check the working of the ormar with fastapi
|
|
def test_all_endpoints():
|
|
# note that TestClient is only sync, don't use asyns here
|
|
client = TestClient(app)
|
|
# note that you need to connect to database manually
|
|
# or use client as contextmanager
|
|
with client as client:
|
|
response = client.post("/categories/", json={"name": "test cat"})
|
|
category = response.json()
|
|
response = client.post(
|
|
"/items/", json={"name": "test", "id": 1, "category": category}
|
|
)
|
|
item = Item(**response.json())
|
|
assert item.pk is not None
|
|
|
|
response = client.get("/items/")
|
|
items = [Item(**item) for item in response.json()]
|
|
assert items[0] == item
|
|
|
|
item.name = "New name"
|
|
response = client.put(f"/items/{item.pk}", json=item.dict())
|
|
assert response.json() == item.dict()
|
|
|
|
response = client.get("/items/")
|
|
items = [Item(**item) for item in response.json()]
|
|
assert items[0].name == "New name"
|
|
|
|
response = client.delete(f"/items/{item.pk}", json=item.dict())
|
|
assert response.json().get("deleted_rows", "__UNDEFINED__") != "__UNDEFINED__"
|
|
response = client.get("/items/")
|
|
items = response.json()
|
|
assert len(items) == 0
|
|
``` |