tgscraper

TGScraper

Eine PHP-Bibliothek, die zum Extrahieren von JSON-Daten (und automatisch generieren PHP-Klassen) von Telegram Bot-API-Dokumentationsseite verwendet wird.

Changelog

Interessiert an jüngsten Änderungen? Schauen Sie sich hier an!

Installation

Installieren Sie die Bibliothek mit Komponisten:

  $ composer require sysbot/tgscraper --prefer-stable

(Optional) Installieren Sie das Cache -Paket:

  $ composer require sysbot/tgscraper-cache

Verwenden Sie aus der Befehlszeile

Nach der Installation können Sie die CLI verwenden, um mit der Bibliothek zu interagieren.

Für grundlegende Hilfe und Befehlsliste:

  $ vendor/bin/tgscraper help

JSON

Extrahieren Sie das neueste Schema in einem menschlich lesbaren JSON:

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

Oder wenn Sie einen Postman-kompatiblen JSON wollen (dank Davtur19):

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

Yaml

Extrahieren Sie das neueste Schema im YAML -Format:

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

OpenAPI

Extrahieren Sie das neueste OpenAPI -Schema im JSON -Format:

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

Oder wenn Sie YAML bevorzugen:

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

Stubs

Hinweis: Da Telegramm das Seitenformat jederzeit ändern kann, verlassen Sie sich nicht auf die automatisch generierten Stubs aus dieser Bibliothek. Überprüfen Sie immer den Code!

TGScraper kann auch Klassenstubs generieren, die Sie in Ihrer Bibliothek verwenden können. Eine Beispielimplementierung ist im Sysbot -Telegrammmodul verfügbar.

Erstellen Sie Stubs im out/ Verzeichnis mit SysbotTelegram als Namespace -Präfix:

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

Alle Versionen

Wenn Sie für jede Bot -API -Version alle Schemas und Stubs generieren möchten, können Sie!

Hier ist ein Beispiel, wie Sie alles in das out/ Verzeichnis exportieren können, mit Schemas im menschlich-lesbaren Format und der Verwendung SysbotTelegram als Namespace-Präfix für die Stubs:

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

Benutzerdefiniertes Format

Wenn Sie an dem von TGScraper generierten benutzerdefinierten Format interessiert sind, finden Sie hier sein Schema.