بتل کد Battle Codeدارد باز می‌شود…

مثال تابع (بک‌اند با پایتون): def all_books(): — طراحی یک API خوب

مثال 6 از درس جلسه‌ی 10 آموزش بک‌اند و ساخت API با پایتون برای نوجوانان: طراحی یک API خوب

API که بزرگ می‌شود، یادت می‌رود چه routeهایی داری. app.show_routes() همه را چاپ می‌کند: متد، آدرس و تابعی که جواب می‌دهد، به ترتیب آدرس. این همان منوی API توست؛ چیزی است که به کسی می‌دهی که قرار است اپ یا سایت را بسازد (به این می‌گویند مستندات، documentation). اگر منو را نگاه کنی و آدرس‌ها شبیه هم و قابل حدس باشند، طراحی‌ات خوب است.

from server import app

@app.get("/books")
def all_books():
    return {"count": 0, "items": []}

@app.get("/books/<int:book_id>")
def one_book(book_id):
    return {"id": book_id}

@app.get("/books/<int:book_id>/reviews")
def book_reviews(book_id):
    return {"count": 0, "items": []}

app.show_routes()

این کد را همین‌جا در ویرایشگر پایتون اجرا کن، عددها و متن‌هایش را عوض کن و دوباره اجرا کن تا ببینی چه تغییری می‌کند.

بیشتر بخوان: تابع در پایتون: آموزش def، پارامتر و return با مثال

← مثال قبلی · برگشت به درس جلسه‌ی 10: طراحی یک API خوب · مثال بعدی → · چالش‌های این جلسه