tgscraper

Tgscraper

Una biblioteca PHP utilizada para extraer datos JSON (y clases de PHP de generación automática) de la página de documentación de la API BOT de Telegram.

Colegio de cambios

¿Interesado en cambios recientes? ¡Mira aquí!

Instalación

Instale la biblioteca con el compositor:

  $ composer require sysbot/tgscraper --prefer-stable

(Opcional) Instale el paquete de caché:

  $ composer require sysbot/tgscraper-cache

Usando desde la línea de comandos

Una vez instalado, puede usar la CLI para interactuar con la biblioteca.

Para la lista básica de ayuda y comandos:

  $ vendor/bin/tgscraper help

Json

Extraiga el último esquema en un JSON legible por humanos:

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

O, si quieres un JSON compatible con el postman (gracias a davtur19):

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

Yaml

Extraiga el último esquema en formato YAML:

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

Openapi

Extraiga el último esquema de Openapi en formato JSON:

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

O, si prefiere Yaml:

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

Tiradas

Nota: Dado que el telegrama puede cambiar el formato de página en cualquier momento, no confíe en los trozos generados automáticamente de esta biblioteca, ¡siempre revise el código!

TGSCRAPER también puede generar trozos de clase que puede usar en su biblioteca. Una implementación de muestra está disponible en el módulo Sysbot Telegram.

Crea stubs en el directorio out/ usando SysbotTelegram como prefijo de espacio de nombres:

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

Todas las versiones

Si desea generar todos los esquemas y trozos para cada versión de Bot API, ¡puede!

Aquí hay un ejemplo sobre cómo exportar todo a la out/ directorio, con esquemas en formato legible por humanos y usar SysbotTelegram como prefijo de espacio de nombres para los trozos:

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

Formato personalizado

Si está interesado en el formato personalizado generado por TGSCraper, puede encontrar su esquema aquí.