Budowanie JSON CRUD API

Wprowadzenie do FastAPI

Matt Eckerle

Software and Data Engineering Leader

Cztery etapy cyklu życia obiektu (CRUD)

Tworzenie, odczyt, aktualizacja i usuwanie wokół bazy danych

Operacje API

Tworzenie

Operacja POST

Odczyt

Operacja GET

Aktualizacja

Operacja PUT

Usuwanie

Operacja DELETE

Motywacja do stosowania JSON CRUD API

Podstawy

Zarządzanie pełnym cyklem życia obiektu
Najlepsze praktyki operacji HTTP API
Projektowanie własnych API do zarządzania danymi

Możliwości

Logika biznesowa dla złożonych operacji na danych
Potoki danych o wysokiej przepustowości
Potoki wnioskowania uczenia maszynowego

Budowanie modułu CRUD

from pydantic import BaseModel

class Review(BaseModel):
    movie: str
    num_stars: int
    text: str

class DbReview(BaseModel):
    movie: str
    num_stars: int
    text: str
    # Reference database ID of Reviews
    review_id: int

# crud.py
def create_review(review: Review):
    # Create review in database

def read_review(review_id: int):
    # Read review from database

def update_review(review: DbReview):
    # Update review in database

def delete_review(review_id: int):
    # Delete review from database

Endpoint POST – tworzenie

Endpoint: /reviews
Wejście: Review
Wyjście: DbReview

@app.post("/reviews", response_model=DbReview)
def create_review(review: Review):
    # Create the movie review in the database
    db_review = crud.create_review(review)
    # Return the created review with database ID
    return db_review

Endpoint GET – odczyt

Endpoint: /reviews
Wejście: ?review_id=1234
Wyjście: DbReview

@app.get("/reviews", response_model=DbReview)
def read_review(review_id: int):
    # Read the movie review from the database
    db_review = crud.read_review(review_id)
    # Return the review
    return db_review

Endpoint PUT – aktualizacja

Endpoint: /reviews
Wejście: DbReview
Wyjście: DbReview

@app.put("/reviews", response_model=DbReview)
def update_review(review: DbReview):
    # Update the movie review in the database
    db_review = crud.update_review(review)
    # Return the updated review
    return db_review

Endpoint DELETE – usuwanie

Endpoint: /reviews
Wejście: DbReview
Wyjście: {}

@app.delete("/reviews")
def delete_review(review: DbReview):
    # Delete the movie review from the database
    crud.delete_review(review.review_id)
    # Return nothing since the data is gone
    return {}

Czas na ćwiczenia!

Wprowadzenie do FastAPI