tgscraper

TGSCRAPER

PHP庫用於從Telegram Bot API文檔頁面中提取JSON數據（和自動生成的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

或者，如果您想要兼容Postman的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

存根

注意：由於電報可以隨時更改頁面格式，因此請勿依靠此庫中的自動生成的存根，請始終查看代碼！

TGSCraper還可以生成可以在庫中使用的類存根。 Sysbot Telegram模塊中有示例實現。

使用SysbotTelegram作為名稱空間前綴在out/ Directory中創建存根：

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

所有版本

如果您想為每個機器人API版本生成所有模式和存根，則可以！

這是一個如何將所有內容導出到out/ Directory的示例，具有人類可讀格式的模式以及使用SysbotTelegram作為Stubs的名稱空間前綴：

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

自定義格式

如果您對TGSCraper生成的自定義格式感興趣，則可以在此處找到其模式。