📝 Add docs
This commit is contained in:
44
docs/tutorial/fastapi/delete.md
Normal file
44
docs/tutorial/fastapi/delete.md
Normal file
@@ -0,0 +1,44 @@
|
||||
# Delete Data with FastAPI
|
||||
|
||||
Let's now add a *path operation* to delete a hero.
|
||||
|
||||
This is quite straightforward. 😁
|
||||
|
||||
## Delete Path Operation
|
||||
|
||||
Because we want to **delete** data, we use an HTTP `DELETE` operation.
|
||||
|
||||
We get a `hero_id` from the path parameter and verify if it exists, just as we did when reading a single hero or when updating it, **possibly raising an error** with a `404` response.
|
||||
|
||||
And if we actually find a hero, we just delete it with the **session**.
|
||||
|
||||
```Python hl_lines="3-11"
|
||||
# Code above omitted 👆
|
||||
|
||||
{!./docs_src/tutorial/fastapi/delete/tutorial001.py[ln:91-99]!}
|
||||
|
||||
# Code below omitted 👇
|
||||
```
|
||||
|
||||
<details>
|
||||
<summary>👀 Full file preview</summary>
|
||||
|
||||
```Python
|
||||
{!./docs_src/tutorial/fastapi/delete/tutorial001.py!}
|
||||
```
|
||||
|
||||
</details>
|
||||
|
||||
After deleting it successfully, we just return a response of:
|
||||
|
||||
```JSON
|
||||
{
|
||||
"ok": true
|
||||
}
|
||||
```
|
||||
|
||||
## Recap
|
||||
|
||||
That's it, feel free to try it out in the interactve docs UI to delete some heroes. 💥
|
||||
|
||||
Using **FastAPI** to read data and combining it with **SQLModel** makes it quite straightforward to delete data from the database.
|
||||
Reference in New Issue
Block a user