FAST API

Chúng ta giao tiếp với nhau qua API, vậy API là gì?

API (Giao diện lập trình ứng dụng) là một công cụ trung gian cho phép các ứng dụng, cơ sở dữ liệu, phần mềm và thiết bị IoT giao tiếp với nhau.

• Concurrency: Đồng thời, nhiều tác vụ chạy cùng một lúc.

Example Concurrency

• Non-Concurrency: Không đồng thời, một tác vụ chạy xong mới tới tác vụ khác.

Then locate localhost:8000/docs to see the Swagger UI.

<img src=“image-8.png’ width=‘300px’>

• Path Parameters are request parameters that have been attached to the URL

• Path Parameters are usually defined as a way to find information based on location

Query Parameters are request parameters that have been attached after a “?” Query Parameters have name=value pairs

• Example: localhost:8000/items/?skip=0&limit=10

Pydantic là một thư viện Python mạnh mẽ được sử dụng để mô hình hóa dữ liệu, phân tích dữ liệu và xử lý lỗi hiệu quả. Nó thường được sử dụng để xác thực dữ liệu và xử lý dữ liệu đến trong ứng dụng FastAPI. Pydantic giúp định nghĩa các mô hình dữ liệu và tự động xác thực, chuyển đổi dữ liệu đầu vào, cung cấp thông báo lỗi chi tiết khi xác thực không thành công.

• Data Modeling:

from pydantic import BaseModel

class Item(BaseModel):
    id: int
    name: str
    price: float

• Data Parsing:

item_data = {"id": 1, "name": "Sample Item", "price": 19.99}
item = Item(**item_data)

• Error Handling:

from pydantic import ValidationError

try:
    item = Item(id="not-an-integer", name="Sample Item", price=19.99)
except ValidationError as e:
    print(e.json())

Annotated và Field trong FastAPI & Pydantic

• Dùng để thêm metadata vào các mô hình (models) của Pydantic.

• Annotated được sử dụng để thêm metadata tùy chỉnh vào các kiểu dữ liệu.

• Field dùng để thêm các trường dữ liệu cho mô hình (ví dụ giá trị mặc định, xác thực dữ liệu), thêm metadata phục vụ cho quá trình truần tự hóa dữ liệu.

from typing import Annotated
from fastapi import FastAPI, Query
from pydantic import BaseModel, Field

app = FastAPI()

items = [
    {
        "name": "Banh thap cam",
        "price": 45.0,
        "description": "Description of the banh trung thu thap cam",
    },
    {
        "name": "Banh dau xanh",
        "price": 40.0,
        "description": "Description of the banh trung thu dau xanh",
    },
]

class Item(BaseModel):
    name: str = Field(..., min_length=1, max_length=100)
    price: float = Field(..., gt=0, description="Price of the mooncake")
    description: str | None = Field(
        None, max_length=500, description="Optional description"
    )

BaseModel: Kế thừa từ BaseModel của Pydantic để xác định mô hình dữ liệu. Field(...):

• min_length=1, max_length=100: Giới hạn độ dài chuỗi cho name.
• gt=0: Giá của bánh phải lớn hơn 0.
• description: Cung cấp mô tả giúp tài liệu API dễ hiểu hơn.
• None, max_length=500: Trường description có thể không bắt buộc (None), nhưng tối đa 500 ký tự.

@app.get("/search_items/")
async def search_items(
    q: Annotated[str, Query(min_length=3, max_length=50, description="Search query")],
    max_price: Annotated[float | None, Query(gt=0, description="Maximum price")] = None,
):
    results = [item for item in items if q.lower() in item["name"].lower()]

    if max_price:
        results = [item for item in results if item["price"] <= max_price]

    return results

Trong ví dụ sau đây có hai cách để xử lí một file upload trong FastAPI

• Direct File Access: Nhận tệp dưới dạng byte và truy cập kích thước của nó.
• Upload file class: Sử dụng UploadFile class cho dạng metata có thể truy cập tên file và content type.

Middleware là một hàm trung gian hoạt động với mọi request trước khi một route (đường dẫn API) cụ thể được xử lý, và cũng mọi response trước khi nó được trả về client. Middleware thường được dùng để:

• Xử lý xác thực (authentication)
• Ghi log (logging)
• Thêm hoặc thay đổi header của request/response
• Giới hạn tốc độ (rate limiting)
• Kiểm tra bảo mật

import time
from fastapi import FastAPI, Request

app = FastAPI()

@app.middleware("http")
async def add_process_time_header(request: Request, call_next):
    # Ghi lại thời gian bắt đầu xử lý request
    start_time = time.perf_counter()
    
    # Gọi middleware tiếp theo hoặc route handler
    response = await call_next(request)
    
    # Tính thời gian xử lý request
    process_time = time.perf_counter() - start_time
    
    # Thêm thời gian xử lý vào response header
    response.headers["X-Process-Time"] = str(process_time)
    
    # Trả về response đã chỉnh sửa
    return response

• FastAPI Middleware: Measures HTTP request processing time.
• Records Start/End Times: Uses time.perf_counter() to track request duration.
• Adds “X-Process-Time” Header: Includes processing time in response headers.
• Calls Next Handler: Passes the request to the next middleware or route.

from fastapi import FastAPI, Request
from starlette.middleware.base import BaseHTTPMiddleware

app = FastAPI()

class CustomMiddleware(BaseHTTPMiddleware):
    async def dispatch(self, request: Request, call_next):
        # Trước khi xử lý request
        print(f"Request: {request.method} {request.url}")
        
        # Chuyển request đến route handler
        response = await call_next(request)
        
        # Sau khi xử lý response
        response.headers["X-Custom-Header"] = "Middleware Example"
        print("Response processed")

        return response

# Thêm middleware vào FastAPI app
app.add_middleware(CustomMiddleware)

@app.get("/")
async def read_root():
    return {"message": "Hello, World!"}

CORS (Cross-Origin Resource Sharing) là một cơ chế cho phép tài nguyên từ một trang web hoặc ứng dụng web được yêu cầu từ một nguồn khác ngoài trang web hoặc ứng dụng web hiện tại. CORS cho phép các trang web hoặc ứng dụng web chia sẻ dữ liệu với các nguồn khác mà không cần lo lắng về việc chặn truy cập từ các nguồn khác.

• Allow requests from specific origins (e.g., http://localhost.tiangolo.com)
• Allow credentials (cookies, authorization headers, etc.)
• Allow all HTTP methods (GET, POST, etc.)
• Enable all headers

Phục vụ các tệp tĩnh tự động từ một thư mục bằng cách sử dụng StaticFiles

“Mounting” có nghĩa là thêm một ứng dụng độc lập vào một đường dẫn cụ thể, sau đó ứng dụng đó sẽ xử lý tất cả các đường dẫn con.

Cơ sở dữ liệu là gì?

• Cơ sở dữ liệu là một tập hợp dữ liệu.
• Nó quản lý dữ liệu, cho phép việc truy xuất, lưu trữ và chỉnh sửa dễ dàng hơn.
• Có nhiều loại Hệ quản trị cơ sở dữ liệu (DBMS).

SQL là gì?

• SQL (Structured Query Language) là ngôn ngữ truy vấn cấu trúc. Nó cho phép người dùng thực hiện các thao tác trên các bản ghi trong cơ sở dữ liệu, thường được gọi là CRUD:
  • Create: Tạo mới bản ghi.
  • Read: Đọc dữ liệu từ bản ghi.
  • Update: Cập nhật dữ liệu trong bản ghi.
  • Delete: Xóa bản ghi.

• Alembic là một công cụ di chuyển cơ sở dữ liệu nhẹ, thường được sử dụng với SQLAlchemy.
• Nó cung cấp các công cụ di chuyển cho phép lập kế hoạch, chuyển giao và nâng cấp tài nguyên trong cơ sở dữ liệu.
• Alembic cho phép bạn thay đổi bảng cơ sở dữ liệu SQLAlchemy sau khi đã tạo.
• Hiện tại, SQLAlchemy chỉ có thể tạo các bảng cơ sở dữ liệu mới mà không thể update các bảng đã có.

• Alembic cung cấp việc tạo và thực thi các script quản lý thay đổi.
• Điều này cho phép bạn tạo môi trường di chuyển và thay đổi dữ liệu theo ý muốn.
• Trong phần này, bạn sẽ học cách sử dụng Alembic cho dự án của mình.

• Alembic là một công cụ di chuyển quan trọng giúp bạn sửa đổi cấu trúc cơ sở dữ liệu khi ứng dụng của bạn phát triển.
• Khi ứng dụng của bạn tiến triển, cơ sở dữ liệu cũng cần phát triển theo.
• Alembic giúp bạn tiếp tục sửa đổi cơ sở dữ liệu để đáp ứng các yêu cầu phát triển nhanh chóng.
• Nó hoạt động trên các bảng đã có dữ liệu, cho phép bạn liên tục tạo nội dung bổ sung phù hợp với ứng dụng của mình.