آموزش جامع توسعه API با Directus و PostgreSQL

در دنیای امروز، APIها نقش حیاتی در ارتباط بین سیستم ها و برنامه های مختلف ایفا می کنند. با استفاده از Directus و PostgreSQL، می توانید به سرعت و به آسانی APIهای قدرتمندی ایجاد کنید که نیازهای کسب وکار شما را برآورده سازند. این مقاله به شما نشان می دهد که چگونه این کار را انجام دهید.

مقدمه ای بر Directus و PostgreSQL

Directus یک CMS بدون هد (Headless CMS) متن باز است که به شما امکان می دهد به پایگاه داده SQL خود (مانند PostgreSQL) متصل شده و به سرعت یک API RESTful ایجاد کنید. این به شما انعطاف پذیری کامل در انتخاب فرانت اند و نحوه نمایش داده ها می دهد.

PostgreSQL یک سیستم مدیریت پایگاه داده رابطه ای (RDBMS) قدرتمند و متن باز است که به دلیل قابلیت اطمینان، مقیاس پذیری و پشتیبانی از ویژگی های پیشرفته شناخته شده است. این یک انتخاب عالی برای پروژه هایی است که نیاز به ذخیره و مدیریت داده های پیچیده دارند.

پیش نیازها

قبل از شروع، مطمئن شوید که موارد زیر را در سیستم خود دارید:

• Node.js و npm (یا yarn)
• Docker و Docker Compose (توصیه می شود)
• یک ویرایشگر کد (مانند VS Code)

نصب و پیکربندی PostgreSQL با Docker

استفاده از Docker ساده ترین راه برای راه اندازی PostgreSQL است. یک فایل docker-compose.yml ایجاد کنید:

        
version: "3.8"
services:
  db:
    image: postgres:14
    restart: always
    environment:
      POSTGRES_USER: directus
      POSTGRES_PASSWORD: your_secret_password
      POSTGRES_DB: directus
    ports:
      - "5432:5432"
    volumes:
      - db_data:/var/lib/postgresql/data

volumes:
  db_data:
        
    

سپس دستور زیر را در ترمینال اجرا کنید:

        
docker-compose up -d
        
    

نصب و پیکربندی Directus

Directus را می توان به روش های مختلفی نصب کرد. در این آموزش، از npm استفاده می کنیم:

        
npm install -g directus
        
    

سپس Directus را با دستور زیر راه اندازی کنید:

        
directus start
        
    

پس از راه اندازی، به آدرس http://localhost:8080 در مرورگر خود بروید و مراحل نصب را دنبال کنید. اطلاعات اتصال به پایگاه داده PostgreSQL خود را وارد کنید.

ایجاد اولین مجموعه (Collection)

در Directus، داده ها در مجموعه ها (Collections) سازماندهی می شوند. برای مثال، می توانید یک مجموعه برای "مقالات" ایجاد کنید.

1. وارد پنل مدیریت Directus شوید.
2. به بخش "Data Model" بروید.
3. روی دکمه "Create New Collection" کلیک کنید.
4. نام مجموعه را وارد کنید (مثلاً "articles").
5. فیلدهای مورد نیاز را اضافه کنید (مثلاً "title"، "content"، "author").
6. نوع داده هر فیلد را مشخص کنید (مثلاً "string"، "text"، "relation").

استفاده از API

پس از ایجاد مجموعه، Directus به طور خودکار یک API RESTful برای آن ایجاد می کند. می توانید از این API برای ایجاد، خواندن، به روزرسانی و حذف داده ها استفاده کنید.

برای مثال، برای دریافت لیست همه مقالات، می توانید از دستور زیر استفاده کنید:

        
GET /items/articles
        
    

برای ایجاد یک مقاله جدید، می توانید از دستور زیر استفاده کنید:

        
POST /items/articles
Content-Type: application/json

{
  "title": "عنوان مقاله جدید",
  "content": "متن مقاله جدید",
  "author": "نویسنده مقاله"
}
        
    

احراز هویت و مجوز

Directus از روش های مختلف احراز هویت و مجوز پشتیبانی می کند. می توانید از JWT (JSON Web Tokens) برای احراز هویت کاربران و کنترل دسترسی به API استفاده کنید.

برای پیکربندی احراز هویت JWT، به بخش "Settings" -> "Authentication" بروید و تنظیمات مورد نظر را اعمال کنید.

سفارشی سازی API

Directus امکان سفارشی سازی API را از طریق اکستنشن ها (Extensions) فراهم می کند. می توانید از اکستنشن ها برای افزودن منطق تجاری سفارشی، ایجاد نقاط پایانی جدید و تغییر رفتار API استفاده کنید.

برای اطلاعات بیشتر در مورد اکستنشن ها، به مستندات Directus مراجعه کنید.

استقرار API

بعد از توسعه API، باید آن را بر روی یک سرور مستقر کنید. می توانید از پلتفرم های مختلفی مانند Heroku، AWS، یا DigitalOcean برای این کار استفاده کنید.

فرآیند استقرار بستگی به پلتفرم انتخابی شما دارد. به طور کلی، شما باید Directus را بر روی سرور نصب کرده و آن را به پایگاه داده PostgreSQL خود متصل کنید.

سوالات متداول (FAQ)