Documentation
¶
Overview ¶
Package triviaapi2 is the library behind the triviaapi2 command line: the HTTP client, request shaping, and the typed data models for The Trivia API v2 (the-trivia-api.com).
The Client here is the spine every command shares. It sets a real User-Agent, paces requests so a busy session stays polite, and retries the transient failures (429 and 5xx) that any public API throws under load.
Index ¶
Constants ¶
const BaseURL = "https://" + Host
BaseURL is the root every request is built from.
const DefaultUserAgent = "triviaapi2-cli/0.1 (tamnd87@gmail.com)"
DefaultUserAgent identifies the client to The Trivia API v2.
const Host = "the-trivia-api.com"
Host is the site this client talks to.
Variables ¶
This section is empty.
Functions ¶
This section is empty.
Types ¶
type CategoryInfo ¶
CategoryInfo describes one trivia category.
type Client ¶
type Client struct {
HTTP *http.Client
UserAgent string
BaseURL string
// Rate is the minimum gap between requests. Zero means no pacing.
Rate time.Duration
Retries int
// contains filtered or unexported fields
}
Client talks to The Trivia API v2 over HTTP.
func (*Client) Get ¶
Get fetches rawURL and returns the response body. It paces and retries according to the client's settings.
func (*Client) GetCategories ¶
func (c *Client) GetCategories(ctx context.Context) ([]*CategoryInfo, error)
GetCategories fetches all trivia categories from /v2/categories.
func (*Client) GetQuestions ¶
func (c *Client) GetQuestions(ctx context.Context, limit int, categories, difficulty string) ([]*Question, error)
GetQuestions fetches trivia questions from /v2/questions. limit: number of questions (1-50, 0 = API default of 1). categories: comma-separated category slugs, empty = all. difficulty: "easy", "medium", "hard", or empty = all.
type Config ¶
type Config struct {
BaseURL string
UserAgent string
Rate time.Duration
Timeout time.Duration
Retries int
}
Config holds tunable parameters for the client.
type Domain ¶
type Domain struct{}
Domain is the triviaapi2 driver. It carries no state; the per-run client is built by the factory Register hands kit.
func (Domain) Classify ¶
Classify is not meaningful for a pure-API service with no page-like URIs. Return an error so `ant resolve` gracefully reports unsupported input.
func (Domain) Info ¶
func (Domain) Info() kit.DomainInfo
Info describes the scheme, the hostnames a pasted link is matched against, and the identity reused for the binary's help and version.
type Question ¶
type Question struct {
ID string `json:"id" kit:"id"`
Category string `json:"category"`
Difficulty string `json:"difficulty"`
Question string `json:"question"`
CorrectAnswer string `json:"correct_answer"`
IncorrectAnswers []string `json:"incorrect_answers"`
Tags []string `json:"tags"`
Type string `json:"type"`
IsNiche bool `json:"is_niche"`
}
Question is one trivia question with its answers and metadata.
Source Files