Основные концепции (знания) в wordpress REST API - Web-Global

Основные концепции (знания) в wordpress REST API

20.03.2023 88
Поделиться:

1. Конечные точки:
Конечные точки — это URL-адреса, представляющие определенный ресурс или группу ресурсов. В WordPress конечные точки начинаются с /wp-json/, за которыми следует маршрут к ресурсу. Например, чтобы получить список всех сообщений, конечной точкой является /wp-json/wp/v2/posts. Здесь /wp-json/ — это префикс для всех конечных точек REST API, wp — это пространство имен для основных ресурсов WordPress, а v2 — номер версии REST API. posts — это ресурс, к которому мы хотим получить доступ.

2. HTTP-глаголы:
HTTP-глаголы используются для указания действия, которое должно быть предпринято с ресурсом. Наиболее распространенными HTTP-глаголами, используемыми в WordPress REST API, являются:

  • GET: Извлекает ресурс или коллекцию ресурсов. Например, GET /wp-json/wp/v2/posts извлекает список сообщений.
  • СООБЩЕНИЕ: Создает новый ресурс. Например, POST /wp-json/wp/v2/posts создает новую запись.
  • ПОМЕСТИТЬ: Заменяет существующий ресурс. Например, PUT /wp-json/wp/v2/posts/123 заменяет сообщение идентификатором 123.
  • ИСПРАВЛЕНИЕ: Обновляет существующий ресурс. Например, ПАТЧ /wp-json/wp/v2/posts/123 обновляет сообщение с идентификатором 123.
  • УДАЛИТЬ: Удаляет ресурс. Например, при удалении /wp-json/wp/v2/posts/123 удаляется запись с идентификатором 123.

    Ресурсы:
    Ресурсы — это данные, к которым осуществляется доступ или которыми манипулируют через REST API. Основные ресурсы WordPress включают:

    • Сообщения: wp/v2/posts
    • Страницы: wp/v2/pages
    • Носитель: wp/v2/media
    • Пользователи: wp/v2/users
    • Комментарии: wp/v2/комментарии
    • Таксономии: wp/v2/taxonomies

    Например, чтобы получить конкретную запись с идентификатором 123, конечной точкой будет /wp-json/wp/v2/posts/123. Чтобы создать новую запись, конечной точкой будет /wp-json/wp/v2/posts.

    JSON:
    WordPress REST API возвращает данные в формате JSON, который представляет собой легкий текстовый формат, который легко читать и записывать для людей, а также легко анализировать и генерировать для машин. Вот пример ответа в формате JSON для сообщения:

    {
        "id": 123,
        "title": {
            "rendered": "Hello World!"
        },
        "content": {
            "rendered": "<p>This is my first post</p>"
        },
        "date": "2023-03-20T10:30:00",
        "author": 1,
        "categories": [4, 5],
        "tags": [10, 11],
        "featured_media": 20
    }
    

    Конечно, вот более подробные объяснения и примеры основных концепций в WordPress REST API:

    Конечные точки:
    Конечные точки — это URL-адреса, представляющие определенный ресурс или группу ресурсов. В WordPress конечные точки начинаются с /wp-json/, за которыми следует маршрут к ресурсу. Например, чтобы получить список всех сообщений, конечной точкой является /wp-json/wp/v2/posts. Здесь /wp-json/ — это префикс для всех конечных точек REST API, wp — это пространство имен для основных ресурсов WordPress, а v2 — номер версии REST API. posts — это ресурс, к которому мы хотим получить доступ.

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

    GET: Извлекает ресурс или коллекцию ресурсов. Например, GET /wp-json/wp/v2/posts извлекает список сообщений.
    СООБЩЕНИЕ: Создает новый ресурс. Например, POST /wp-json/wp/v2/posts создает новую запись.
    ПОМЕСТИТЬ: Заменяет существующий ресурс. Например, PUT /wp-json/wp/v2/posts/123 заменяет сообщение идентификатором 123.
    ИСПРАВЛЕНИЕ: Обновляет существующий ресурс. Например, ПАТЧ /wp-json/wp/v2/posts/123 обновляет сообщение с идентификатором 123.
    УДАЛИТЬ: Удаляет ресурс. Например, при удалении /wp-json/wp/v2/posts/123 удаляется запись с идентификатором 123.
    Ресурсы:
    Ресурсы — это данные, к которым осуществляется доступ или которыми манипулируют через REST API. Основные ресурсы WordPress включают:
    Сообщения: wp/v2/posts
    Страницы: wp/v2/pages
    Носитель: wp/v2/media
    Пользователи: wp/v2/users
    Комментарии: wp/v2/комментарии
    Таксономии: wp/v2/taxonomies


    Например, чтобы получить конкретную запись с идентификатором 123, конечной точкой будет /wp-json/wp/v2/posts/123. Чтобы создать новую запись, конечной точкой будет /wp-json/wp/v2/posts.

    JSON:
    WordPress REST API возвращает данные в формате JSON, который представляет собой легкий текстовый формат, который легко читать и записывать для людей, а также легко анализировать и генерировать для машин. Вот пример ответа в формате JSON для сообщения:
    css
    Скопировать код
    {
    «идентификатор»: 123,
    «название»: {
    «визуализировано»: «Привет, мир!»
    },
    «содержимое»: {
    «визуализировано»: «

    Это мой первый пост»
    },
    «дата»: «2023-03-20T10:30:00»,
    «автор»: 1,
    «категории»: [4, 5],
    «теги»: [10, 11],
    «featured_media»: 20
    }


    Идентификация:
    WordPress REST API требует аутентификации для доступа к определенным конечным точкам или выполнения определенных действий. В WordPress доступно несколько методов аутентификации:
    Аутентификация с помощью файлов cookie: использует файлы cookie WordPress для аутентификации запросов.
    Базовая аутентификация: Использует базовую аутентификацию HTTP для проверки подлинности запросов.
    Аутентификация OAuth 1.0a: использует протокол OAuth 1.0a для аутентификации запросов.
    Пароли приложений: Генерирует уникальный пароль для приложения для проверки подлинности запросов.
    Пагинация:
    Чтобы избежать одновременного возврата слишком большого количества данных, WordPress REST API использует разбивку на страницы для разделения больших результатов на более мелкие, управляемые фрагменты. Разбиением на страницы можно управлять с помощью параметров в запросе API. Например, для извлечения первых 10 сообщений конечной точкой будет /wp-json/wp/v2/posts?per_page=10&page=1. Здесь параметр per_page задает