Что такое WordPress REST API и как вы его используете?

Вы, наверное, слышали о REST API. Возможно, вы слышали, что пользователи WordPress получают от этого пользу. Но вам также может быть интересно, что такое WordPress API.

Понимание того, как работают API, не так сложно, как кажется. Продолжайте читать, чтобы узнать, что такое API, что такое REST API и как вы можете использовать WordPress REST API на своих сайтах.

Что такое API?

Интерфейс прикладных программ (API) — это способ для двух приложений «общаться» друг с другом. Одна система делает запрос, а другая его выполняет. Запросы, которые принимает система, должны быть включены в API — иначе запрос не может быть выполнен.

Подумайте об этом таким образом. Может быть, вы действительно голодны, поэтому вы идете в Waffle House. Вы заказываете кофе, яйца и блины. Официантка начинает записывать ваш заказ — а потом путается, когда вы доходите до блинов. Waffle House не предлагает блины. Они подают только вафли.

Система, запрашивающая блины из меню API, которое предлагает только вафли, останется голодной.

Что такое REST API?

Когда мы говорим REST API, мы говорим о системе ограничений, разработанной для Интернета. Он описывает, как один веб-сайт может запрашивать информацию с другого веб-сайта таким образом, чтобы он был масштабируемым и единообразным. REST расшифровывается как Representational State Transfer, который был определен Роем Филдингом в его докторской диссертации.

Что такое REST API WordPress?

WordPress REST API относится к запросам, сделанным на веб-сайт, работающий на WordPress. Если мы запрашиваем список сообщений или страниц, мы можем ожидать получения этой информации от WordPress REST API. WordPress никогда не будет предоставлять какую-либо информацию, которая не является общедоступной, например, черновики сообщений или (что более важно) пароли пользователей.

Это основа редактора блоков, который динамически обменивается данными с WordPress без перезагрузки страницы. Каждая конечная точка возвращает данные в формате JSON, который может быть прочитан JavaScript, или, в данном случае, блоки.

Обратите внимание, что REST API — это только один из API, предоставляемых WordPress. Также есть, например, API базы данных и API метаданных, которые используются плагинами для взаимодействия с WordPress на сервере. Вы можете узнать больше об API WordPress в Кодексе.

Как работает запрос WordPress REST API?

Есть несколько основных частей REST API, а именно: маршруты, конечные точки, запросы и ответы.

Маршруты

Маршрут — это то, как мы ссылаемся на URL-адрес, по которому общается веб-сайт. Распространенный маршрут в WordPress — «/wp-admin». Хотя это и не маршрут REST API, это маршрут, используемый браузером для доступа к панели администратора WordPress. Для наших целей маршруты REST API начинаются с «/wp-json» (стандартным форматом данных является JSON).

Конечные точки

Конечная точка — это комбинация маршрута и типа входящего запроса. Один маршрут может подключаться к нескольким конечным точкам, поскольку существует несколько типов запросов. Общие типы запросов включают GET (как мы читаем данные по маршруту) и POST (как мы обновляем данные по маршруту).

Запросы и ответы

Каждое взаимодействие с REST API находится между запросом и ответом. Одна система делает запрос, на который другая система отвечает. WordPress REST API включает удобные объекты для плагинов для доступа к данным запроса (WP_REST_Request) и управления данными ответа (WP_REST_Response) при расширении WordPress REST API.

Как установить REST API в WordPress

Начиная с версии WordPress 4.7, WordPress включает REST API в качестве основной функции.

Если вы используете более старую версию, вы можете установить подключаемый модуль функции json-rest-api. Это использовалось для разработки REST API до полной интеграции с кодовой базой WordPress. Этот плагин технически закрыт, поэтому рекомендуется вместо этого обновить вашу версию WordPress (или, возможно, рассмотреть вариант управляемого хостинга WordPress, и вы всегда будете в курсе последних событий).

Примеры REST API WordPress

Посмотрите на сайте GiveWP. Если вы зайдете в их блог, вы сможете увидеть последние новости и сообщения. Этот маршрут отображает HTML, на который приятно смотреть, но с которым программисту сложно взаимодействовать. Вместо этого сообщения становятся доступными для программистов по маршруту «/wp-json/wp/v2/posts».

Маршрут «/wp-json/wp/v2/posts» говорит нам, что это ресурс WordPress («/wp»), что это версия 2 («/v2/») ресурса и, в частности, что это сообщения («/сообщения»). Если вы еще этого не сделали, посетите https://givewp.com/wp-json/wp/v2/posts и сравните то, что вы видите, с https://givewp.com/blog/. Даю подсказку — это та же информация!

В качестве примера того, как REST API используется в WordPress, рассмотрим блок последних сообщений. Чтобы получить список постов в WordPress, сайту традиционно нужно было сделать запрос на сервер, а затем повторно отобразить всю страницу.

Блок последних сообщений может запрашивать только сообщения, а затем повторно отображать себя. Это делается с помощью REST API. И он может делать это несколько раз, чтобы опросить новые сообщения — без повторного рендеринга всей страницы. Это особенно полезно, когда вы рассматриваете полное редактирование сайта, в котором блоки используются для редактирования и отображения компонентов страницы.

Каждый отдельный компонент может запрашивать данные, которые ему нужны (включая проверку обновлений), а затем повторно отображать только то, что изменилось.

Теперь ты знаешь

Теперь, когда вы поняли назначение и структуру WordPress REST API, покопайтесь, чтобы посмотреть, что вы можете найти самостоятельно. Полный обзор использования и расширения WordPress REST API см. в Руководстве по REST API.

Помните: если кто-то спросит вас об API, вы не сможете заказать блины в Waffle House.

Пока вы настраиваете свой сайт, не забывайте, что хорошим сайтам нужен отличный хостинг. Вы получаете все это с управляемым WordPress от Nexcess. Благодаря высокой скорости, параметрам масштабируемости и превосходной поддержке вы можете положиться на Nexcess для обеспечения работы своего сайта WordPress.

Приходите и узнайте, почему в Nexcess встроено лучшее. Ознакомьтесь с нашими планами полностью управляемого хостинга WordPress сегодня.

Связанные ресурсы WordPress

• WordPress.com против WordPress.org
• 5 передовых методов для ускорения вашего сайта WordPress
• Что такое хостинг WordPress?
• Основное руководство по плагинам WordPress
• Как выбрать веб-хостинг: на что обратить внимание и чего избегать