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生成的自定义格式感兴趣，则可以在此处找到其模式。