پیاده سازی GraphQL در جنگو

در این بخش به بررسی نحوه پیاده سازی GraphQL در Django می پردازیم، در سال‌های اخیر، GraphQL به عنوان یک زبان پرس‌وجو (Query Language) قدرتمند برای ساخت API‌های انعطاف‌پذیر و کارآمد به شدت مورد توجه قرار گرفته است. برخلاف REST، که روشی سنتی و ثابت برای برقراری ارتباط بین کلاینت و سرور فراهم می‌کند، GraphQL امکان ارسال درخواست‌های انعطاف‌پذیرتری را به برنامه‌نویسان می‌دهد. با استفاده از GraphQL، کلاینت‌ها می‌توانند دقیقاً مشخص کنند که چه داده‌هایی را نیاز دارند، بدون این که داده‌های اضافی به سرور ارسال یا دریافت کنند. همین ویژگی GraphQL باعث می‌شود که APIها سریع‌تر، بهینه‌تر و قابل کنترل‌تر شوند.

Django، به عنوان یکی از فریم‌ورک‌های محبوب توسعه وب در پایتون، معمولاً برای ساخت و مدیریت APIها به کمک Django REST Framework به کار می‌رود. با این حال، با افزوده شدن پشتیبانی از GraphQL از طریق کتابخانه‌هایی مانند Graphene-Django، توسعه‌دهندگان Django می‌توانند به راحتی APIهای GraphQL را در پروژه‌های خود پیاده‌سازی کنند. در این مقاله، به صورت جامع به نحوه‌ی پیاده‌سازی GraphQL در Django خواهیم پرداخت و روش‌ها و مثال‌هایی را برای استفاده از GraphQL در پروژه‌های Django بیان خواهیم کرد.

نصب و پیکربندی GraphQL در Django

اولین قدم برای استفاده از GraphQL در Django نصب کتابخانه‌ی Graphene-Django است. این کتابخانه به عنوان ابزاری ساده و کارآمد برای افزودن GraphQL به پروژه‌های Django عمل می‌کند.

نصب Graphene-Django

برای شروع، ابتدا با اجرای دستور زیر کتابخانه Graphene-Django را نصب می‌کنیم:

pip install graphene-django

پس از نصب، لازم است این کتابخانه را به لیست برنامه‌های نصب‌شده (INSTALLED_APPS) در فایل تنظیمات Django اضافه کنیم. به فایل settings.py مراجعه کرده و خط زیر را به آن اضافه کنید:

INSTALLED_APPS = [
    ...
    'graphene_django',
    ...
]

پیکربندی تنظیمات GraphQL

پس از نصب و افزودن کتابخانه به پروژه، باید تنظیمات مرتبط با GraphQL را در فایل settings.py تعریف کنیم. برای این کار، کد زیر را به تنظیمات خود اضافه کنید:

GRAPHENE = {
    'SCHEMA': 'myapp.schema.schema'  # فایل schema.py در برنامه‌ی خود
}

در اینجا، myapp نام برنامه‌ی شماست. باید فایل schema.py را در برنامه‌ی خود ایجاد کنید تا بتوانید اسکیمای GraphQL خود را تعریف کنید.

تعریف Schema و Queryها در GraphQL

یکی از مراحل اساسی در پیاده‌سازی GraphQL در Django، تعریف Schema و Query است. در GraphQL، Schema مسئول تعریف ساختار داده و نحوه‌ی ارتباط بین اجزای مختلف است، در حالی که Queryها درخواست‌های خاصی هستند که کلاینت می‌تواند از سرور بپرسد.

ایجاد فایل schema.py

ابتدا یک فایل جدید به نام schema.py در برنامه‌ی خود ایجاد کنید. این فایل مکانی است که اسکیمای اصلی و Queryهای پروژه‌ی خود را در آن تعریف می‌کنیم.

تعریف یک Query ساده

فرض کنیم که می‌خواهیم اطلاعات کاربرانی که در مدل User در Django ثبت شده‌اند را از طریق GraphQL به دست آوریم. برای این کار، ابتدا باید در فایل schema.py کوئری مرتبط را ایجاد کنیم:

در این کد:

• UserType: نوع GraphQL برای مدل User است.
• Query: یک Query ساده تعریف شده است که لیست تمام کاربران را برمی‌گرداند.
• resolve_all_users: تابعی است که اطلاعات کاربران را از دیتابیس استخراج کرده و به عنوان نتیجه‌ی Query بازمی‌گرداند.

اجرا و تست Query در GraphQL

پس از تعریف Query، نیاز است که URL مربوط به GraphQL را به پروژه اضافه کنیم. برای این کار، ابتدا فایل urls.py پروژه را باز کرده و URL مربوطه را اضافه کنید:

این URL به ما امکان می‌دهد که به GraphQL IDE در Django دسترسی داشته باشیم و Queryهای خود را به صورت گرافیکی تست کنیم. حالا اگر سرور Django را راه‌اندازی کنید و به آدرس /graphql/ مراجعه کنید، می‌توانید Queryهایی که در بخش قبلی تعریف کردیم را اجرا کنید. مثلاً می‌توانید Query زیر را برای گرفتن اطلاعات کاربران اجرا کنید:

{
  allUsers {
    id
    username
    email
  }
}

این Query، لیست کاربران را به همراه شناسه، نام کاربری و ایمیل آن‌ها برمی‌گرداند.

تعریف Mutationها در GraphQL

علاوه بر Queryها، در GraphQL می‌توان Mutationها را نیز تعریف کرد. Mutationها عملیات‌هایی مانند ایجاد، به‌روزرسانی و حذف داده‌ها را فراهم می‌کنند.

مثال: ایجاد Mutation برای اضافه کردن کاربر جدید

در فایل schema.py، Mutation جدیدی برای اضافه کردن کاربر جدید به پروژه ایجاد می‌کنیم:

در این مثال:

• CreateUser: یک Mutation جدید تعریف شده که با استفاده از آن می‌توان کاربر جدیدی به سیستم اضافه کرد.
• mutate: این تابع عملیاتی برای ایجاد و ذخیره‌ی کاربر جدید انجام می‌دهد.

اجرای Mutation

برای افزودن کاربر جدید، می‌توانید Mutation زیر را در GraphQL IDE اجرا کنید:

mutation {
  createUser(username: "newuser", password: "newpassword", email: "newuser@example.com") {
    user {
      id
      username
      email
    }
  }
}

پیاده‌سازی GraphQL در Django به شما امکان می‌دهد تا APIهای قابل انعطاف و کاربرپسندی ایجاد کنید. در این مقاله، نحوه‌ی نصب و راه‌اندازی GraphQL، تعریف Queryها و Mutationها، و تست درخواست‌ها را بررسی کردیم. با این روش، شما می‌توانید پروژه‌های Django خود را با استفاده از GraphQL بهینه‌تر کنید و تجربه کاربری بهتری را برای کلاینت‌ها فراهم آورید.