tgscraper

Tgscraper

Uma biblioteca PHP usada para extrair dados JSON (e classes de PHP automaticamente generadas) da página de documentação da API do Telegram Bot.

Changelog

Interessado em mudanças recentes? Dê uma olhada aqui!

Instalação

Instale a biblioteca com o Composer:

  $ composer require sysbot/tgscraper --prefer-stable

(Opcional) Instale o pacote de cache:

  $ composer require sysbot/tgscraper-cache

Usando da linha de comando

Depois de instalado, você pode usar a CLI para interagir com a biblioteca.

Para Ajuda Básica e Lista de Comando:

  $ vendor/bin/tgscraper help

JSON

Extraia o esquema mais recente em um JSON legível por humanos:

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

Ou, se você quiser um JSON compatível com o Postman (graças a Davtur19):

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

Yaml

Extraia o esquema mais recente no formato YAML:

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

Openapi

Extraia o esquema mais recente do OpenAPI no formato JSON:

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

Ou, se você preferir YAML:

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

Stubs

Nota: Como o Telegram pode alterar o formato da página a qualquer momento, não confie nos stubs gerados automaticamente dessa biblioteca, sempre revise o código!

O TGscRaper também pode gerar stubs de classe que você pode usar em sua biblioteca. Uma implementação de amostra está disponível no módulo SYSBOT Telegram.

Crie stubs no diretório out/ Usando SysbotTelegram como namespace Prefix:

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

Todas as versões

Se você deseja gerar todos os esquemas e stubs para cada versão da API de bot, você pode!

Aqui está um exemplo de como exportar tudo para o out/ , com esquemas em formato legível por humanos e usando SysbotTelegram como prefixo de namespace para os stubs:

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

Formato personalizado

Se você estiver interessado no formato personalizado gerado pelo TGscraper, poderá encontrar seu esquema aqui.