Перейти к содержанию

SMF RESTful API

SMF RESTful API — модификация для форума SMF 2.1, добавляющая поверх движка полноценный REST-интерфейс с ответами в формате JSON. Мод регистрирует единственное действие index.php?action=api и передаёт запрос собственному маршрутизатору. Обращение к ресурсу выглядит как index.php?action=api;path=v1/members/5, а при настроенном правиле перезаписи — как /api/v1/members/5.

Мод поставляется выключенным: включите его и настройте ключи в «Админка → Конфигурация → Настройки модов → RESTful API». Пока мод выключен, любой эндпоинт отвечает 503.

Начните с раздела Начало работы, посмотрите Справочник API со всеми эндпоинтами, полями и кодами ошибок, затем см. Чистые URL и Расширение API.

  • Только хуки


    Без правок ядра. Мод регистрирует index.php?action=api и делегирует собственному роутеру — API включается, а ключи настраиваются в «Админка → Конфигурация → Настройки модов → RESTful API».

  • Полный набор ресурсов


    Категории, пользователи, группы пользователей, разделы, темы и сообщения с GET/POST/PUT/PATCH/DELETE. Чтение через Query с {query_see_board} и пагинацией; запись через штатные функции SMF.

  • Аутентификация как в SMF


    API-ключ через Authorization: Bearer, X-API-Key или параметр api_key. После аутентификации восстанавливается полный контекст пользователя SMF ($user_info, allowedTo(), {query_see_board}).

  • Чистые URL опционально


    Обращение как index.php?action=api;path=v1/members/5 или через rewrite как /api/v1/members/5. Правила для Apache и Nginx прилагаются.

  • Расширяемость через хуки


    Сторонние моды регистрируют маршруты, схемы аутентификации и правят ответы через хуки integrate_api_* без патчей этого мода.

  • Проверяемая документация


    Документация собирается Zensical — Markdown-исходники, валидация ссылок при сборке и локализация на английский/русский.