botdoc

Documentation

Overview

Command botdoc fetches the published Telegram Bot API documentation and inspects the structured types and methods extracted from it. It is a developer tool: a reference oracle while hand-writing the library and a way to spot API drift.

Examples:

# Summary (version, counts) from the live docs:
go run ./cmd/botdoc

# List every method name:
go run ./cmd/botdoc -methods

# Show the fields and return type of one definition:
go run ./cmd/botdoc -name SendMessage
go run ./cmd/botdoc -name Message

# Dump the whole extracted API as JSON (e.g. to diff across versions):
go run ./cmd/botdoc -json > api.json

# Work offline from a saved page:
go run ./cmd/botdoc -file api.html -types