tgscraper

Tgscraper

Perpustakaan PHP yang digunakan untuk mengekstrak data JSON (dan kelas PHP generat otomatis) dari halaman dokumentasi API Telegram.

Changelog

Tertarik dengan perubahan terbaru? Lihat di sini!

Instalasi

Instal perpustakaan dengan komposer:

  $ composer require sysbot/tgscraper --prefer-stable

(Opsional) Instal paket cache:

  $ composer require sysbot/tgscraper-cache

Menggunakan dari baris perintah

Setelah diinstal, Anda dapat menggunakan CLI untuk berinteraksi dengan perpustakaan.

Untuk Bantuan Dasar dan Daftar Perintah:

  $ vendor/bin/tgscraper help

Json

Ekstrak skema terbaru dalam JSON yang dapat dibaca manusia:

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

Atau, jika Anda menginginkan JSON yang kompatibel dengan tukang pos (terima kasih kepada Davtur19):

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

Yaml

Ekstrak skema terbaru dalam format YAML:

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

Openapi

Ekstrak skema OpenAPI terbaru dalam format JSON:

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

Atau, jika Anda lebih suka YAML:

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

Stubs

Catatan: Karena Telegram dapat mengubah format halaman kapan saja, jangan bergantung pada stubs yang dihasilkan secara otomatis dari perpustakaan ini, selalu tinjau kode!

TGSCraper juga dapat menghasilkan potongan kelas yang dapat Anda gunakan di perpustakaan Anda. Implementasi sampel tersedia dalam modul Telegram Sysbot.

Buat Stubs di Direktori out/ Menggunakan SysbotTelegram sebagai Awalan Namespace:

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

Semua versi

Jika Anda ingin menghasilkan semua skema dan stub untuk setiap versi API bot, Anda bisa!

Berikut adalah contoh tentang cara mengekspor semuanya ke out/ direktori, dengan skema dalam format yang dapat dibaca manusia dan menggunakan SysbotTelegram sebagai awalan namespace untuk stubs:

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

Format khusus

Jika Anda tertarik dengan format khusus yang dihasilkan oleh TGSCraper, Anda dapat menemukan skema di sini.