tgscraper

Tgscraper

Une bibliothèque PHP utilisée pour extraire les données JSON (et les classes PHP généreuses automatiquement) à partir de la page de documentation de l'API Bot Telegram.

Changelog

Intéressé par les changements récents? Jetez un œil ici!

Installation

Installez la bibliothèque avec le compositeur:

  $ composer require sysbot/tgscraper --prefer-stable

(Facultatif) Installez le package de cache:

  $ composer require sysbot/tgscraper-cache

Utilisation de la ligne de commande

Une fois installé, vous pouvez utiliser la CLI pour interagir avec la bibliothèque.

Pour l'aide et la liste de commandes de base:

  $ vendor/bin/tgscraper help

Json

Extraire le dernier schéma dans un JSON lisible par l'homme:

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

Ou, si vous voulez un JSON compatible avec facteur (merci à Davtur19):

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

Yaml

Extraire le dernier schéma au format YAML:

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

Openapi

Extraire le dernier schéma OpenAPI au format JSON:

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

Ou, si vous préférez Yaml:

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

Talons

Remarque: Étant donné que Telegram peut modifier le format de page à tout moment, ne comptez pas sur les talons générés automatiquement à partir de cette bibliothèque, passez en revue le code!

TGSCCraper peut également générer des talons de classe que vous pouvez utiliser dans votre bibliothèque. Un exemple de mise en œuvre est disponible dans le module Sysbot Telegram.

Créer des talons dans le répertoire out/ en utilisant SysbotTelegram comme préfixe d'espace de noms:

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

Toutes les versions

Si vous souhaitez générer tous les schémas et talons pour chaque version de l'API Bot, vous pouvez!

Voici un exemple sur la façon d'exporter tout vers le répertoire out/ , avec des schémas au format lisible par l'homme et en utilisant SysbotTelegram comme préfixe d'espace de noms pour les talons:

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

Format personnalisé

Si vous êtes intéressé par le format personnalisé généré par TGSCCraper, vous pouvez trouver son schéma ici.