آموزش وردپرس REST API – راهنمای مبتدیان

آیا به دنبال یک آموزش وردپرس REST API برای مبتدیان هستید؟ سپس شما به جای مناسب آمده اید! در این مقاله، شما را با پروژه WordPress REST API آشنا می‌کنیم، توضیح می‌دهیم که چرا این یک معامله بزرگ است و بینش‌هایی ارائه می‌کنیم. روی روش استفاده از آن

معرفی وردپرس REST API

باقی مانده (انتقال دولتی نمایندگی) API یک سبک معماری نرم افزاری است که روش ارتباط سرویس های وب با یکدیگر از طریق پروتکل انتقال ابرمتن را تعیین می کند.

در ژوئن 2013، رایان مک کیو و ریچل بیکر از وردپرس پروژه REST API را در GitHub. پس از به دست آوردن حمایت عمومی فراوان و جذب نزدیک به 100 مشارکت کننده برای بهبود آینده، این پروژه به هسته وردپرس اضافه شد. دسامبر 2015.

اکنون تقریباً هر حرفه ای که با وردپرس کار می کند نام REST API را شنیده است. با این حال، از زمان ادغام اصلی آن، فقط توسعه دهندگان پیشرفته وقت گذاشته اند تا یاد بگیرند که این ویژگی جدید چقدر می تواند قدرتمند باشد. این بسیار مایه تاسف است زیرا این ابزار می تواند فرصت های بی پایانی را برای گسترش وب سایت وردپرس شما باز کند.

WordPress REST API با هدف ارائه یک API داخلی است که می تواند با تم ها، برنامه های کاربردی تلفن همراه و موارد دیگر ادغام شود. این به وردپرس اجازه می دهد تا با هر برنامه ای تعامل داشته باشد و توسعه دهندگان حتی می توانند از آن برای ساخت API های خود استفاده کنند.

می توانید از آن در پروژه های خود نیز بهره ببرید. مثلا، اسپرسو رویداد از WordPress REST API برای دسترسی به زیرساخت داخلی خود استفاده می کند و امکان توسعه برنامه های مبتنی بر آن را فراهم می کند روی خدمات آنها

چگونه WordPress REST API کار می کند

انواع زیادی وجود دارد رابط های برنامه نویسی کاربردی (API) در حال حاضر، اما REST به عنوان یک استاندارد مدرن برجسته است. با دستکاری داده های متنی از یک مکان به مکان دیگر بدون دسترسی مستقیم به پایگاه داده یا رابط کاربری کار می کند.

REST API از طریق نقاط پایانی پروتکل انتقال ابرمتن (HTTP) و با استفاده از قالب‌بندی جاوا اسکریپت Object Notation (JSON) ارائه می‌شود. این نقاط پایانی نشان دهنده پست ها، صفحات و سایر انواع داده های وردپرس هستند.

اگر قبلاً با جاوا اسکریپت یا نماد شیء آن کار نکرده اید، توصیه می کنیم ابتدا با اصول اولیه JSON آشنا شوید. این به شما کمک می کند تا این آموزش وردپرس REST API را بهتر درک کنید.

چرا WordPress REST API برای توسعه دهندگان مهم است

به لطف فرمت JSON، WordPress REST API به وردپرس اجازه می دهد تا داده ها را با سایر وب سایت ها و نرم افزارهای نوشته شده به هر زبان برنامه نویسی مبادله کند. از این رو، توسعه دهندگان دیگر محدود به PHP نیستند و می توانند از وردپرس برای مدیریت داده ها از طریق REST API استفاده کنند.

تمرکز فزاینده روی API همچنین بحث هایی را در مورد مهم ترین زبان برنامه نویسی برای یادگیری مطرح می کند. از آنجایی که REST API مبتنی است روی جاوا اسکریپت، ممکن است به زودی متوجه شوید که جاوا اسکریپت سمت سرور می تواند به طور کلی جایگزین PHP شود.

این مفهوم با این واقعیت پشتیبانی می شود که نرم افزار جدید WordPress.com، کالیپسو، به طور کامل اجرا می شود روی JavaScript و REST API.

علاوه بر این، با استاندارد کردن روش تعامل برنامه‌ها با داده‌های وردپرس، توسعه وردپرس ساده‌تر و سریع‌تر می‌شود.

به همین دلیل، آموزش WordPress REST API ما اینجا است تا شما را تشویق کند که به این ویژگی توجه بیشتری داشته باشید.

5 مرحله برای شروع کار با WordPress Rest API

در این آموزش وردپرس REST API، ما از آن استفاده خواهیم کرد command-line رابط (CLI) برای اجرای تمام درخواست ها. CLI شما را قادر می سازد تا بدون نیاز به نوشتن اسکریپت های اضافی برای درخواست و درخواست، به راحتی با REST API تعامل داشته باشید process اطلاعات.

اولین کاری که باید انجام دهید این است که یک برنامه CLI را باز کنید روی کامپیوتر شما: ترمینال برای macOS و لینوکس و PuTTY برای ویندوز. پس از آن، آدرس IP مشترک یا اختصاصی خود را کپی کنید و با اعتبار SSH خود وارد شوید.

همچنین توصیه می کنیم از یک سایت دمو یا تست محلی برای این آموزش استفاده کنید. علاوه بر این، مطمئن شوید که اجرا می شود روی وردپرس نسخه 4.4 یا بالاتر نیز.

مرحله 1: با مفاهیم کلیدی REST API آشنا شوید

ما آموزش WordPress REST API خود را با توضیح مفاهیم و اصطلاحات کلیدی آغاز خواهیم کرد:

• مسیرها & نقاط پایانی — یک مسیر یک URL است که می توانید آن را به روش های مختلف HTTP نگاشت کنید، در حالی که نقطه پایانی ارتباطی بین یک روش HTTP فردی و یک مسیر است. /wp-json/ نمونه ای از یک مسیر است و شامل تمام نقاط پایانی مربوطه است.
• درخواست ها – یک نمونه از WP_REST_Request. برای ذخیره و بازیابی اطلاعات درخواست فعلی استفاده می شود.
• پاسخ – داده‌هایی را که درخواست کرده‌اید ارائه می‌کند یا یک خطا برمی‌گرداند تا به شما اطلاع دهد که چه اشتباهی رخ داده است.
• طرحواره – فهرستی از تمام خصوصیات و پارامترهای ورودی را که REST API می‌تواند بپذیرد و برگرداند، به شما نشان می‌دهد.
• کلاس های کنترلر – مکانی که قطعات متحرک REST API را مدیریت می کنید.

مرحله 2: با مفیدترین نقاط پایانی REST API آشنا شوید

در این قسمت از آموزش REST API، چندین نقطه پایانی مفید REST API را به شما نشان می دهیم که می توانید با سایت خود آزمایش کنید:

1. اول از همه، باید بدانید که چگونه یک فراخوانی HTTP با REST API ایجاد کنید. اساس هر تماس WordPress REST API به شرح زیر است:

   http://yourdomain.com/wp-json/

2. سپس، می توانید اتصال را با اجرای آن تست کنید حلقه دستور در CLI شما:

   curl -X OPTIONS -i http://yourdomain.com/wp-json/

   باید یک پیام HTTP موفقیت آمیز از شما خواسته شود:

   HTTP/1.1 200 OK
   Date: Wed, 23 Oct 2019 19:51:41 GMT
   Server: Apache/2.4.29
   X-Robots-Tag: noindex
   Link: <http://yourdomain.com/wp-json/>; rel="https://api.w.org/"
   X-Content-Type-Options: nosniff
   Access-Control-Expose-Headers: X-WP-Total, X-WP-TotalPages
   Access-Control-Allow-Headers: Authorization, Content-Type
   Allow: GET
   Transfer-Encoding: chunked
   Content-Type: application/json; charset=UTF-8

3. در مرحله بعد، می توانید این دستور را با استفاده از چندین نقطه پایانی شستشو داده و تکرار کنید. این بار، ما به سادگی از نسخه GET curl برای گرفتن لیست JSON از پست های وردپرس شما استفاده می کنیم. برای این کار می توانید از دستور زیر استفاده کنید:

   curl -X GET -i http://yourdomain.com/wp-json/wp/v2/posts

   از طرف دیگر، ممکن است بخواهید این دستور را برای بررسی تمام صفحات موجود وردپرس خود امتحان کنید:

   curl -X GET -i http://yourdomain.com/wp-json/wp/v2/pages

اگر می‌خواهید نمونه‌های بیشتری ببینید، WordPress REST API ارائه می‌دهد راهنمای مرجع که حاوی بسیاری از نقاط پایانی مفید است.

مرحله 3: اصول احراز هویت REST API را بیاموزید

برخی از اقدامات و داده‌ها در REST API عمومی هستند، در حالی که برخی دیگر از شما می‌خواهند که به عنوان سرپرست وارد سیستم شوید. با این حال، از آنجایی که REST API است، جایی برای ورود به سیستم وجود ندارد.

برای دور زدن این مشکل، می‌توانید هنگام برقراری تماسی که نیاز به دسترسی مدیریتی دارد، مانند مشاهده محتوای منتشر نشده یا به‌روزرسانی یک پست، خود را احراز هویت کنید.

برای این آموزش، از افزونه WordPress REST API Basic Auth استفاده خواهیم کرد. این یک افزونه ساده فقط برای توسعه دهندگان است که به شما در یادگیری REST API کمک می کند، اما برای سایت های زنده در نظر گرفته نشده است. در اینجا روش نصب افزونه آورده شده است:

1. API وردپرس REST را دانلود کنید اعتبار پایه افزونه
2. وارد داشبورد وردپرس خود شوید و به آن بروید پلاگین -> افزودن جدید. کلیک روی را آپلود افزونه را فشار دهید و فایل فشرده افزونه را انتخاب کنید.
3. برو به پلاگین های نصب شده منو و از آنجا افزونه را فعال کنید.
4. وقتی Basic Auth نصب شد، CLI را باز کنید و با استفاده از یک درخواست API احراز هویت کنید. کاربر پرچم. در اینجا مثالی از روش اعمال روش احراز هویت کاربر با استفاده از curl برای مشاهده پست های منتشر نشده آورده شده است:

   curl -X GET --user username:password -i http://yourdomain.com/wp-json/wp/v2/posts؟status=draft

هشدار! به خاطر داشته باشید که روش احراز هویت ذکر شده اعتبارنامه های رمزگذاری شده را ارسال می کند. با این حال، آنها رمزگذاری نشده اند. اگر از طریق یک اتصال امن HTTPS/TLS انجام نشود، چنین روشی می‌تواند بسیار ناامن باشد.

اکنون که به احراز هویت اولیه دست پیدا کرده اید، می توانید سایر روش های توصیه شده را در آن بررسی کنید مستندات REST API.

مرحله 4: اولین پست وردپرس خود را با REST API انتخاب کنید

هنگامی که روش برقراری تماس های اولیه با REST API با استفاده از دستور curl را فهمیدید، می توانید با انتخاب یک پست خاص ادامه دهید:

1. ابتدا، تمام پست های خود را همانطور که قبلا انجام دادیم فهرست کنید:

   curl -X GET -i http://yourdomain.com/wp-json/wp/v2/posts

2. شناسه پستی را که می‌خواهید به‌روزرسانی کنید پیدا کنید. برای انتخاب یک پست فردی، باید یک شناسه به انتهای درخواست خود اضافه کنید:

   curl -X GET -i http://yourdomain.com/wp-json/wp/v2/posts/<ID>

می توانید از این دستور برای انتخاب یک شناسه معین برای هر نقطه پایانی REST API استفاده کنید، خواه این یک پست باشد. page، یا طبقه بندی

مرحله 5: اولین پست وردپرس خود را با REST API به روز کنید

در نهایت، بیایید سعی کنیم یک به روز رسانی به پست انتخابی خود ارسال کنیم. برای این آموزش REST API، سعی می کنیم با استفاده از دستور POST نام پست خود را تغییر دهیم. فراموش نکنید که اعتبارنامه احراز هویت را نیز درج کنید.

تغییرات جدید با استفاده از د پرچم در پایان فرمان ما.

1. در این مثال، یک متغیر شی جاوا اسکریپت سفارشی (عنوان) را به یک مقدار سفارشی (عنوان جدید من) ارسال می کنید:

   curl -X POST --user username:password http://yourdomain.com/wp-json/wp/v2/posts/PostID -d '{"title":"My New Title"}'

curl -X GET -i http://yourdomain.com/wp-json/wp/v2/posts/PostID

تبریک می گویم! شما به تازگی اولین ویرایش های اداری خود را با استفاده از WordPress REST API انجام داده اید.

نتیجه

REST API افزودنی قدرتمند به هسته وردپرس است و توسعه دهندگان شروع به کشف قابلیت های آن کرده اند، مانند ایجاد یک سایت وردپرس بدون سر. بنابراین، یادگیری کار با آن می‌تواند مهارت‌های شما را بهبود بخشد و شما را قادر می‌سازد برنامه‌هایی ایجاد کنید که از خدمات وردپرس استفاده می‌کنند.

در این آموزش وردپرس REST API، پنج مرحله مهم برای تسلط بر این ویژگی را یاد گرفتید:

1. با مفاهیم کلیدی REST API آشنا شوید.
2. با مفیدترین نقاط پایانی REST API آشنا شوید.
3. اصول احراز هویت REST API را بیاموزید.
4. اولین پست وردپرس خود را با REST API انتخاب کنید.
5. یک پست وردپرس را با REST API به روز کنید.

در حالی که این آموزش وردپرس REST API فقط سطح قابلیت های آن را خراش می دهد، ما فکر می کنیم هنوز یک نقطه شروع خوب است قبل از اینکه عمیق تر به آن بپردازید.

آیا هیچ سوالی دارید؟ در بخش نظرات زیر به ما اطلاع دهید!