MongoDB

MongoDB — Data API (Data API)

آخرین بروزرسانی: 1404/08/20
قبلی: اعتبارسنجی (Validation) بعدی: درایورها (Drivers)

Data API (Data API)

«Data API» راه ساده وبی برای کار با مونگوست. بدون درایور کار می کند. فقط با درخواست های HTTPS حرف می زنیم. این یعنی سریع وصل می شوی. سپس می خوانی، می نویسی، و حتی تجمیع انجام می دهی.

Data API چیست؟

Data API یک سری Endpoint آماده است. هر Endpoint کاری انجام می دهد. مثلاً findOne یک سند برمی گرداند. این روش برای اپ های سبک عالی است. وقتی درایور سنگین است، از آن استفاده کن.

راه اندازی در Atlas

  1. در داشبورد Atlas، بخش Data API را باز کن.
  2. دیتاسورس های لازم را انتخاب کن.
  3. روی Enable the Data API کلیک کن.

سطح دسترسی و کلید API

ابتدا هیچ دسترسی فعال نیست. سپس یکی را انتخاب کن: No Access، Read Only، Read and Write، یا Custom.

بعد کلید بساز. نام بده و کلید را Generate کن. کلید را امن نگه دار.

هشدار: کلید را عمومی نکن. در کد کلاینت خام نگذار.

نمونه درخواست با curl

curl --location --request POST 'https://data.mongodb-api.com/app/<DATA API APP ID>/endpoint/data/v1/action/findOne' \
--header 'Content-Type: application/json' \
--header 'Access-Control-Request-Headers: *' \
--header 'api-key: <DATA API KEY>' \
--data-raw '{
    "dataSource": "<CLUSTER NAME>",
    "database": "sample_mflix",
    "collection": "movies",
    "projection": { "title": 1 }
}'

مشاهده در ادیتور

نقاط انتهایی رایج

  • POST .../findOne: یافتن یک سند.
  • POST .../find: یافتن چند سند.
  • POST .../insertOne و insertMany: درج سند.
  • POST .../updateOne و updateMany: بروزرسانی.
  • POST .../deleteOne و deleteMany: حذف سند.
  • POST .../aggregate: اجرای پایپ لاین تجمیع.

برای جستجو متنی، صفحه ایندکس گذاری/جستجو (Indexing/Search) را ببین. همچنین لینک Data API مونگو را نگه دار.

جمع بندی سریع

  • Data API بدون درایور کار می کند.
  • Endpointها کارهای CRUD و Aggregation را پوشش می دهند.
  • اول Data API را در Atlas فعال کن.
  • دسترسی مناسب تعیین کن.
  • کلید API را امن نگه دار.
قبلی: اعتبارسنجی (Validation) بعدی: درایورها (Drivers)