Skip to content

Документация API (PRO)

Готовое описание публичного API вашего сайта — не написанное руками, а собранное из того, что сейчас опубликовано.

PageBlocks → Конструктор → Документация API.

Внутри вкладки живёт Swagger UI. Он берёт два источника:

  • таблицы, у которых на вкладке API стоит галочка отдавать по API;
  • объекты, объявленные в core/App/api.php.

Запрос прямо отсюда

Нажмите Authorize, вставьте токен из вкладки API-токены — и можно дёргать методы, не выходя из менеджера. Это самый быстрый способ проверить, что клиент увидит то же самое.

Спецификация файлом

/mgr/pb/openapi.json?ctx=mgr

Обычный OpenAPI: открывается в Postman, скармливается генератору клиента. То есть фронтендер получает типизированный клиент, не переписывая руками ни одного эндпоинта.

Описание не устаревает

Его никто не пишет и не поддерживает: опубликовали таблицу по API — она появилась, сняли галочку — исчезла. Расходиться с действительностью тут нечему.

Что и как публиковать — в REST API.

© PageBlocks 2019-present