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

مثال تابع (بک‌اند با پایتون): def search():

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

خطاها یک شکل دارند. هر خطا یک دیکشنری با کلید error است و کد وضعیت درست: {"error": "no book with id 9"} با 404، یا {"error": "add ?q=..."} با 400. abort(404, "...") خودش همین شکل را می‌سازد؛ اگر خودت برمی‌گردانی، بنویس return {"error": "..."}, 400. حتی 404 خودِ سرور برای آدرسی که نیست همین شکل را دارد. این‌طوری مشتری همیشه می‌داند خطا کجاست: r.json["error"]. پیام را کوتاه و روشن بنویس و اگر می‌شود بگو چه کار کند.

from server import app, ask, request

@app.get("/search")
def search():
    q = request.args.get("q")
    if not q:
        return {"error": "add ?q=... (for example ?q=hobbit)"}, 400
    return {"q": q, "count": 0, "items": []}

ask("GET /search")
ask("GET /serch?q=hobbit")
r = ask("GET /search", quiet=True)
print(r.status, r.json["error"])

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

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

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