API WordPress: что это такое и как их использовать
Опубликовано: 2024-09-13WordPress JSON REST API вызвал настоящий ажиотаж в сообществе WordPress, предлагая новые возможности как разработчикам, так и создателям контента.
Хотя это может показаться сложным, понимание ключевых терминов, таких как JSON, REST и API, может упростить ваше взаимодействие с широкими возможностями WordPress.
Что такое API?
API означает «интерфейс прикладного программирования», который, по сути, представляет собой набор инструкций и стандартов программирования, которые позволяют различным программным приложениям взаимодействовать друг с другом.
Представьте себе, что одно программное приложение дает указания другому. API — это набор согласованных правил, управляющих этим взаимодействием. Когда одна часть программного обеспечения отправляет инструкции другой, API облегчает действие или предоставляет необходимую информацию.
Вы можете думать об API как о «пользовательском интерфейсе» между двумя программными системами, обеспечивающем передачу данных и выполнение задач, но невидимом для конечного пользователя.
Примеры API
Доступ к API — это здорово при разработке веб-приложений. Когда API публикуется, это означает, что разработчики создали решения, основанные на сервисе программного обеспечения. Зачастую они избавляют от необходимости изобретать велосипед для многих задач, поскольку они уже созданы.
Отличным примером API является Amazon. Amazon выпустила свой API, чтобы разработчики могли легко получить доступ к продуктам и их информации. Доступ к этому позволяет легко публиковать ссылки на продукты на Amazon с обновленными ценами и возможностью покупки.
Другим примером взаимодействия API может быть покупка билетов на концерты. Чтобы официально приобрести билеты, вам необходимо ввести данные своей кредитной карты. API используется для отправки информации о вашей кредитной карте в удаленное приложение, которое затем проверяет правильность информации о кредитной карте.
Как только все будет проверено, удаленное приложение отправит ответ обратно на веб-сайт билетов, сообщая, что можно продолжить, после чего вы успешно приобрели билеты. Когда все это происходит, вы видите только один интерфейс — сайт билетов. Это непрерывный процесс; «за кулисами» многие приложения работают вместе, используя API, но вы, как пользователь, не замечаете, когда задачи передаются из одного приложения в другое.
API и WordPress
Amazon и покупка билетов — отличные примеры совместной работы API, но как это применимо к WordPress?
Ну, все те же идеи применимы. С помощью WordPress API вы можете отправлять и извлекать данные в WordPress и из него.
API — это ключевой инструмент, который разработчики могут использовать для легкого обмена данными со своего веб-сайта WordPress на другие веб-сайты или приложения. В частности, этот API позволяет выполнять действия create
, read
, update
и delete
(CRUD) над контентом WordPress. Вот несколько примеров типов контента:
- Сообщения
- Пользовательские типы сообщений
- Страницы
- Таксономии
- Пользователи
- СМИ
Что означает ОТДЫХ?
Здесь нет дремоты или храпа — REST относится к архитектурному стилю API. REST означает передачу представительского состояния.
Помните, как мы упоминали, что API обеспечивает специфику взаимодействия, чтобы программы могли взаимодействовать друг с другом? REST API разработаны таким образом, что они предоставляют упрощенный метод связи, который экономит полосу пропускания. WordPress JSON REST API делает именно это, что делает его отличным вариантом при наличии большого объема данных.
Мы только что коснулись поверхности REST; если вы хотите узнать больше, ознакомьтесь с этим полезным руководством по REST.
Формат JSON
Чтобы получить доступ к данным, нам нужен источник, из которого можно их извлечь. Здесь на помощь приходит JSON. JSON означает нотацию объектов JavaScript.
JSON легко читается и понимается как людьми, так и машинами. Это идеальный способ хранения информации в организованном и легкодоступном виде. Поскольку доступ к JSON настолько прост, он отлично подходит для создания REST API и является идеальным решением для WordPress JSON REST API.
Вот основное представление о том, как выглядит формат JSON:
[джаваскрипт]
{"сотрудники":[
{"firstName":"Джейн", "lastName":"Смит"},
{“firstName”:”Анна”, “lastName”:”Олсен”},
{"firstName":"Джош", "lastName":"Джонс"}
]}
[/джаваскрипт]
Формат JSON в WordPress
JSON не просто записывается сам по себе, но не волнуйтесь, вам не нужно вручную создавать файл JSON. Есть плагины, которые могут создать это за вас. С помощью одного из этих инструментов данные сайта будут в правильном формате, включая пользователей, сообщения, страницы, таксономии и многое другое.
Использование JSON REST API
Использование API не требует пояснений; вы будете получать данные своего сайта в простом формате JSON. А если у вас установлен плагин, вы можете поиграть с просмотром сообщений вашего сайта в форме данных.
Получить или обновить данные так же просто, как отправить HTTP-запрос. HTTP — это протокол запросов/ответов. Сначала вы отправляете запрос на данные, а затем данные отправляются обратно в качестве ответа.
ПОЛУЧИТЬ метод
Метод GET используется для получения информации и не влияет на данные. Просто отправьте запрос GET на адрес /wp-json/wp/v2/posts
. Хотите что-то поискать? Например, если вы ищете «разработка», вы получите результаты с помощью запроса GET /wp-json/wp/v2/posts?search=development
.
POST-запрос
POST-запрос используется для отправки данных. Например, благодаря возможностям нового API вы можете обновить пользователя. Допустим, вы хотите обновить пользователя с идентификатором 10. Все, что вам нужно сделать, это отправить запрос POST на /wp-json/wp/v2/users/10
.
Чтобы попробовать это, мы рекомендуем использовать Postman, расширение Google Chrome.
Больше Javascript в миксе
Backbone.js и API
Backbone.js — отличный способ работы с API, поскольку это платформа, предназначенная для работы с REST API. API WordPress включает простой в использовании API Javascript, основанный на моделях Backbone. Это позволяет разработчикам плагинов и тем приступить к работе без особых усилий и знаний о деталях подключения.
Это еще не все, но Backbone придает структуру веб-приложениям, предоставляя модели, коллекции и представления, и подключает все это к API WordPress через интерфейс REST JSON.
Что это значит для разработчиков WordPress?
С появлением API WordPress количество новых способов его использования увеличилось и будет продолжать расти по мере того, как он набирает популярность. API WordPress может улучшить практически любую существующую функциональность WordPress, основанную на Javascript. Вот несколько примеров:
- проверка/отправка формы
- Темы и плагины Backbone.js
- бесконечная прокрутка
Это также отличный способ показать контент из других источников. Теперь можно легко отображать контент с отдельного сайта в рамках настройки нескольких сайтов. Также возможно отображать контент с совершенно отдельного сайта WordPress. Помимо отображения контента, его также можно более легко и эффективно обновлять.
Теперь, когда мы рассмотрели некоторые основные термины, мы знаем, что JSON — это нотация, REST — это архитектурный стиль, а API — это интерфейс, который они составляют. Знание основ API и его возможностей обеспечит вам хороший старт при изучении новых возможностей API WordPress.