tgscraper

tgscraper

Telegram Bot APIドキュメントページからJSONデータ（および自動生成PHPクラス）を抽出するために使用されるPHPライブラリ。

Changelog

最近の変更に興味がありますか？ここを見てください！

インストール

作曲家にライブラリをインストールします。

  $ 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

YAML形式で最新のスキーマを抽出します。

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

Openapi

JSON形式で最新のOpenapiスキーマを抽出します。

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

または、YAMLを好む場合：

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

スタブ

注：Telegramはいつでもページ形式を変更する可能性があるため、このライブラリから自動化されたスタブに依存せず、常にコードを確認してください！

TGScraperは、ライブラリで使用できるクラススタブを生成することもできます。 Sysbot Telegramモジュールでは、サンプルの実装が利用できます。

SysbotTelegram名前空間プレフィックスとして使用して、 out/ディレクトリにスタブを作成します。

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

すべてのバージョン

すべてのボットAPIバージョンのすべてのスキーマとスタブを生成したい場合は、できます！

すべてをout/ディレクトリにエクスポートする方法の例を示します。スキーマは人間が読み取る形式のスキーマを使用し、 SysbotTelegramスタブの名前空間プレフィックスとして使用します。

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

カスタム形式

TGScraperによって生成されたカスタム形式に興味がある場合は、こちらを見つけることができます。