tgscraper

TGSCRAPER

Библиотека PHP, используемая для извлечения данных JSON (и автоматических классов PHP) со страницы документации Telegram BOT API.

Изменение

Заинтересованы в последних изменениях? Посмотрите здесь!

Установка

Установите библиотеку с помощью композитора:

  $ composer require sysbot/tgscraper --prefer-stable

(Необязательно) Установите пакет кеша:

  $ composer require sysbot/tgscraper-cache

Использование из командной строки

После установки вы можете использовать CLI для взаимодействия с библиотекой.

Для базовой помощи и списка команд:

  $ vendor/bin/tgscraper help

Json

Извлеките последнюю схему в прочитанный человеком JSON:

  $ vendor/bin/tgscraper app:export-schema --readable botapi.json

Или, если вы хотите, чтобы почтальонном совместимых JSON (спасибо Davtur19):

  $ vendor/bin/tgscraper app:export-schema --postman botapi_postman.json

Ямл

Извлеките последнюю схему в формате YAML:

  $ vendor/bin/tgscraper app:export-schema --yaml botapi.yaml

Openapi

Извлеките последнюю схему OpenAPI в формате JSON:

  $ vendor/bin/tgscraper app:export-schema --openapi botapi_openapi.json

Или, если вы предпочитаете YAML:

  $ vendor/bin/tgscraper app:export-schema --openapi --yaml botapi_openapi.yaml

Заглушки

Примечание. Поскольку Telegram может изменить формат страницы в любое время, не полагайтесь на автоматически сгенерированные заглушки из этой библиотеки, всегда просмотрите код!

TGSCRAPER также может генерировать заглушки класса, которые вы можете использовать в своей библиотеке. Образец реализации доступна в модуле Telegram Sysbot.

Создайте заглушки в каталоге out/ SysbotTelegram

  $ vendor/bin/tgscraper app:create-stubs --namespace-prefix " SysbotTelegram " out

Все версии

Если вы хотите генерировать все схемы и заглушки для каждой версии API BOT, вы можете!

Вот пример того, как экспортировать все в каталог out/ с схемами в формате, читаемом человеком, и с использованием SysbotTelegram в качестве префикса пространства имен для заглушек:

  $ vendor/bin/tgscraper app:dump-schemas -r --namespace-prefix " SysbotTelegram " out

Пользовательский формат

Если вы заинтересованы в пользовательском формате, сгенерированном TGSCRARE, вы можете найти его схему здесь.