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

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

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

اشتباه‌های رایج:
- فعل در آدرس: /getBooks یا /books/delete/3. کار را متد بگوید.
- خطا با 200: return {"error": "no such book"} بدون 404. مشتری r.ok را True می‌بیند و فکر می‌کند همه‌چیز خوب است!
- شکل‌های مختلف: یک جا {"error": ...}، یک جا {"message": ...}، یک جا متن Not found!. مشتری گیج می‌شود.
- اسم‌های قاطی: یک جا /book/3، یک جا /books. همیشه جمع.

from server import app, ask

@app.get("/books/<int:book_id>")
def one_book(book_id):
    return {"error": "no such book"}

r = ask("GET /books/9")
print("ok?", r.ok)

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

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

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