کدهای آماده برای کار با REST API در پایتون

🗺️ نقشه راه سریع برای کدنویسی REST API با پایتون

تمام چیزی که برای شروع نیاز داری در یک نگاه!

        pip install requests
    

        import requests
        import json # برای نمایش بهتر JSON

        URL = "https://jsonplaceholder.typicode.com/todos/1"
        
        # ارسال درخواست GET
        response = requests.get(URL)

        # بررسی وضعیت پاسخ
        if response.status_code == 200:
            # گرفتن اطلاعات به صورت JSON
            data = response.json()
            print("داده‌های دریافتی:")
            print(json.dumps(data, indent=2, ensure_ascii=False))
        else:
            print(f"خطا در دریافت اطلاعات: {response.status_code}")
            print(f"متن خطا: {response.text}")
    

        import requests
        import json

        URL = "https://jsonplaceholder.typicode.com/todos"
        params = {
            "userId": 2,
            "_limit": 5 # برای محدود کردن نتایج
        }

        response = requests.get(URL, params=params)

        if response.status_code == 200:
            todos = response.json()
            print("کارهای کاربر شماره 2:")
            print(json.dumps(todos, indent=2, ensure_ascii=False))
        else:
            print(f"خطا: {response.status_code}")
    

        import requests
        import json

        URL = "https://api.github.com/users/octocat" # یک API واقعی برای مثال
        headers = {
            "Accept": "application/vnd.github.v3+json", # هدر خاص گیت‌هاب
            "User-Agent": "Python-Requests-Script"
        }

        response = requests.get(URL, headers=headers)

        if response.status_code == 200:
            user_info = response.json()
            print("اطلاعات کاربر GitHub:")
            print(json.dumps(user_info, indent=2, ensure_ascii=False))
        else:
            print(f"خطا: {response.status_code}")
    

        import requests
        import json

        URL = "https://jsonplaceholder.typicode.com/posts"
        new_post_data = {
            "title": "عنوان تست از پایتون",
            "body": "این یک پست تستی است که با پایتون ساخته شده.",
            "userId": 1
        }

        # requests به صورت خودکار content-type را به application/json تنظیم می کند
        response = requests.post(URL, json=new_post_data)

        if response.status_code == 201: # 201 Created
            created_post = response.json()
            print("پست جدید با موفقیت ساخته شد:")
            print(json.dumps(created_post, indent=2, ensure_ascii=False))
        else:
            print(f"خطا در ساخت پست: {response.status_code}")
            print(f"متن خطا: {response.text}")
    

        import requests
        import json

        URL = "http://httpbin.org/post" # یک سرویس تستی برای مشاهده درخواست ها
        form_data = {
            "username": "python_dev",
            "password": "secure_password"
        }

        # ارسال داده به صورت فرم
        response = requests.post(URL, data=form_data)

        if response.status_code == 200:
            print("پاسخ سرور با Form-Data:")
            print(json.dumps(response.json(), indent=2, ensure_ascii=False))
        else:
            print(f"خطا: {response.status_code}")
    

        import requests
        from requests.auth import HTTPBasicAuth
        import json

        URL = "http://httpbin.org/basic-auth/user/passwd"
        username = "user"
        password = "passwd"

        response = requests.get(URL, auth=HTTPBasicAuth(username, password))

        if response.status_code == 200:
            print("احراز هویت با موفقیت انجام شد:")
            print(json.dumps(response.json(), indent=2, ensure_ascii=False))
        else:
            print(f"خطا در احراز هویت: {response.status_code}")
            print(f"متن خطا: {response.text}")
    

        import requests
        import json
        import os # برای گرفتن توکن از متغیرهای محیطی

        SECURE_API_URL = "https://some.secure.api.com/data" # یک URL فرضی
        API_TOKEN = os.getenv("MY_API_TOKEN", "YOUR_ACTUAL_TOKEN_HERE") # توکن رو از متغیر محیطی بگیر

        headers = {
            "Authorization": f"Bearer {API_TOKEN}",
            "Content-Type": "application/json"
        }

        # با توکن در هدر
        response_token = requests.get(SECURE_API_URL, headers=headers)
        if response_token.status_code == 200:
            print("داده‌های امن با توکن:")
            print(json.dumps(response_token.json(), indent=2, ensure_ascii=False))
        else:
            print(f"خطا در دسترسی با توکن: {response_token.status_code}")

        # یا با API Key به عنوان پارامتر (کمتر رایج و امن)
        params_with_apikey = {
            "apiKey": API_TOKEN
        }
        response_apikey = requests.get(SECURE_API_URL, params=params_with_apikey)
        if response_apikey.status_code == 200:
            print("داده‌های امن با API Key در پارامتر:")
            print(json.dumps(response_apikey.json(), indent=2, ensure_ascii=False))
        else:
            print(f"خطا در دسترسی با API Key: {response_apikey.status_code}")
    

        import requests

        URL_SUCCESS = "https://jsonplaceholder.typicode.com/todos/1"
        URL_NOT_FOUND = "https://jsonplaceholder.typicode.com/todos/999999"

        try:
            response_ok = requests.get(URL_SUCCESS)
            response_ok.raise_for_status() # اگه خطا باشه، استثنا ایجاد میشه
            print("درخواست موفق بود.")
            print(response_ok.json())
        except requests.exceptions.HTTPError as err:
            print(f"خطای HTTP در درخواست موفق: {err}")
        except requests.exceptions.ConnectionError as err:
            print(f"خطای اتصال در درخواست موفق: {err}")

        print("n--- امتحان کردن یک URL با خطا ---")

        try:
            response_error = requests.get(URL_NOT_FOUND)
            response_error.raise_for_status()
            print("درخواست خطا موفق بود (نباید اینو ببینیم!).")
        except requests.exceptions.HTTPError as err:
            print(f"خطای HTTP: {err}")
            print(f"کد وضعیت: {err.response.status_code}")
            print(f"متن پاسخ: {err.response.text}")
        except requests.exceptions.RequestException as err:
            print(f"خطای نامشخص در درخواست: {err}")
    

        import requests
        import json

        URL = "https://jsonplaceholder.typicode.com/posts/1"
        updated_data = {
            "id": 1,
            "title": "عنوان جدید به روزرسانی شده",
            "body": "محتوای جدید برای پست شماره یک.",
            "userId": 1
        }

        response = requests.put(URL, json=updated_data)

        if response.status_code == 200:
            print("پست با موفقیت به روز شد (PUT):")
            print(json.dumps(response.json(), indent=2, ensure_ascii=False))
        else:
            print(f"خطا در به روزرسانی (PUT): {response.status_code}")
    

        import requests
        import json

        URL = "https://jsonplaceholder.typicode.com/posts/1"
        partial_update_data = {
            "title": "فقط عنوان به روز شد"
        }

        response = requests.patch(URL, json=partial_update_data)

        if response.status_code == 200:
            print("پست با موفقیت به روز شد (PATCH):")
            print(json.dumps(response.json(), indent=2, ensure_ascii=False))
        else:
            print(f"خطا در به روزرسانی جزئی (PATCH): {response.status_code}")
    

        import requests

        URL = "https://jsonplaceholder.typicode.com/posts/1" # برای تست این پست حذف می شود

        response = requests.delete(URL)

        if response.status_code == 200: # یا 204 No Content
            print("پست با موفقیت حذف شد.")
        else:
            print(f"خطا در حذف پست: {response.status_code}")
            print(f"متن خطا: {response.text}")
    

        import requests

        # ساخت یک شی Session
        with requests.Session() as session:
            # تنظیم یک هدر پیش‌فرض برای تمام درخواست‌های این سشن
            session.headers.update({"User-Agent": "My-Custom-App/1.0"})

            # درخواست اول (کوکی تنظیم می‌شود)
            response1 = session.get("http://httpbin.org/cookies/set/sessioncookie/12345")
            print(f"پاسخ سشن 1 (تنظیم کوکی): {response1.status_code}")

            # درخواست دوم (کوکی ارسال می‌شود)
            response2 = session.get("http://httpbin.org/cookies")
            print("کوکی‌های ارسالی در درخواست دوم:")
            print(response2.json())
            assert response2.json()["cookies"]["sessioncookie"] == "12345"
    

        import requests
        import json
        from io import StringIO

        URL = "http://httpbin.org/post"

        # فرض کنید یک فایل متنی داریم
        file_content = "این محتوای فایل تستی است.nخط دوم فایل."
        dummy_file = StringIO(file_content)

        files = {"upload_file": ("my_test_file.txt", dummy_file, "text/plain")}

        response = requests.post(URL, files=files)

        if response.status_code == 200:
            print("فایل با موفقیت آپلود شد:")
            response_json = response.json()
            print(json.dumps(response_json, indent=2, ensure_ascii=False))
            print(f"نام فایل دریافتی: {response_json['files']['upload_file']}")
        else:
            print(f"خطا در آپلود فایل: {response.status_code}")
    

        import requests

        URL_SLOW = "http://httpbin.org/delay/5" # این URL 5 ثانیه تاخیر داره

        try:
            # 2 ثانیه برای اتصال، 5 ثانیه برای دریافت پاسخ
            response = requests.get(URL_SLOW, timeout=(2, 3)) # 3 ثانیه برای پاسخ، پس باید timeout بخوره
            print("درخواست با موفقیت انجام شد.")
        except requests.exceptions.Timeout as err:
            print(f"درخواست به دلیل Timeout ناموفق بود: {err}")
        except requests.exceptions.RequestException as err:
            print(f"خطای کلی در درخواست: {err}")
    

        import requests
        import json

        upload_url = "http://httpbin.org/post" # یک سرور تستی برای آپلود فایل

        # ساخت یک فایل ساختگی برای مثال
        with open("temp_upload_file.txt", "w", encoding="utf-8") as f:
            f.write("این یک فایل برای تست آپلود است.nمحتوای آزمایشی.")

        try:
            with open("temp_upload_file.txt", "rb") as f:
                files = {"my_file": f}
                data_fields = {"description": "توضیحات فایل", "category": "docs"}
                response = requests.post(upload_url, files=files, data=data_fields)

            response.raise_for_status()
            print("فایل با موفقیت آپلود شد!")
            print(json.dumps(response.json(), indent=2, ensure_ascii=False))
        except Exception as e:
            print(f"خطا در آپلود فایل: {e}")
        finally:
            os.remove("temp_upload_file.txt") # حذف فایل موقتی
    

🛠️ مشکلات رایج و راه حل‌ها

• ❌ HTTPError: 401 Unauthorized یا 403 Forbidden

  مشکل: دسترسی به API رد شده.
  راه حل:

  1. توکن یا API Key رو دوباره چک کن. مطمئن شو که تاریخ انقضا نداشته باشه یا درست کپی شده باشه.
  2. مطمئن شو که توکن/کلید رو توی هدر Authorization با فرمت صحیح (مثلاً Bearer YOUR_TOKEN) می‌فرستی.
  3. امتیازهای دسترسی (permissions) توکن رو بررسی کن. شاید توکن شما اجازه دسترسی به اون منبع خاص رو نداره.

• ❌ HTTPError: 400 Bad Request

  مشکل: داده‌های ارسالی شما مشکل داره.
  راه حل:

  1. ساختار JSON رو دوبار چک کن. آیا همه فیلدهای اجباری هستن؟ آیا نوع داده‌ها (رشته، عدد، بولین) درسته؟
  2. هدر Content-Type رو بررسی کن. اگه JSON می‌فرستی، باید application/json باشه. requests معمولاً خودش اینو تنظیم می‌کنه ولی گاهی ممکنه لازم باشه دستی ستش کنی.
  3. متن خطا (response.text یا response.json()) رو بخون. معمولاً API پیام‌های خطای مفیدی برمی‌گردونه.

• ❌ ConnectionError: Max retries exceeded with url…

  مشکل: برنامه نتونسته به سرور API وصل بشه.
  راه حل:

  1. اول از همه، آدرس URL رو چک کن که درست باشه. تایپو (غلط املایی) رایجه!
  2. اینترنت خودت رو بررسی کن.
  3. مطمئن شو که سرور API بالا باشه و مشکلی نداشته باشه.
  4. اگه پشت فایروال یا پروکسی هستی، تنظیمات مربوط به پروکسی رو توی requests انجام بده.

• ❌ Timeout: The read operation timed out

  مشکل: سرور در زمان مشخص شده پاسخ نداد.
  راه حل:

  1. مقدار timeout رو افزایش بده (timeout=10 یا بیشتر).
  2. عملکرد سرور API رو بررسی کن. شاید سرور کند شده یا تحت بار زیاده.