jokeapi

package

v0.1.3 Latest Latest Go to latest Published: Jun 14, 2026 License: Apache-2.0 Imports: 9 Imported by: 0

Details

Valid go.mod file
Redistributable license
Tagged version
Stable version
Learn more about best practices

Repository

github.com/tamnd/jokeapi-cli

Links

Open Source Insights

Documentation ¶

Overview ¶

Package jokeapi is the library behind the jokeapi command line: the HTTP client, request shaping, and the typed data models for official-joke-api.appspot.com.

The Client sets a real User-Agent, paces requests so a busy session stays polite, and retries the transient failures (429 and 5xx) that any public site throws under load.

Index ¶

Constants
type Client
- func NewClient(cfg Config) *Client
- func (c *Client) ByType(ctx context.Context, jokeType string, count int) ([]Joke, error)
- func (c *Client) Random(ctx context.Context, count int) ([]Joke, error)
type Config
- func DefaultConfig() Config
type Domain
type Joke

Constants ¶

View Source

const Host = "official-joke-api.appspot.com"

Host is the site this client talks to.

Variables ¶

This section is empty.

Functions ¶

This section is empty.

Types ¶

type Client ¶

type Client struct {
	// contains filtered or unexported fields
}

Client talks to official-joke-api.appspot.com over HTTP.

func NewClient ¶

func NewClient(cfg Config) *Client

NewClient returns a Client configured with cfg.

func (*Client) ByType ¶ added in v0.1.3

func (c *Client) ByType(ctx context.Context, jokeType string, count int) ([]Joke, error)

ByType fetches jokes of a given type. If count <= 1, it uses /jokes/{type}/random (returns array of 1). If count > 1 (up to 10), it uses /jokes/{type}/ten (returns up to 10 jokes, trimmed to count).

func (*Client) Random ¶ added in v0.1.3

func (c *Client) Random(ctx context.Context, count int) ([]Joke, error)

Random fetches count random jokes. If count == 1, it uses /random_joke (returns a single object). If count > 1, it uses /jokes/random/{count} (returns an array).

type Config ¶ added in v0.1.1

type Config struct {
	BaseURL   string
	UserAgent string
	Rate      time.Duration
	Timeout   time.Duration
	Retries   int
}

Config holds all tunable parameters for the Client.

func DefaultConfig ¶ added in v0.1.1

func DefaultConfig() Config

DefaultConfig returns a Config with sensible defaults.

type Domain ¶

type Domain struct{}

Domain is the jokeapi driver.

func (Domain) Classify ¶

func (Domain) Classify(input string) (uriType, id string, err error)

Classify turns an input into the canonical (type, id).

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.

func (Domain) Locate ¶

func (Domain) Locate(uriType, id string) (string, error)

Locate returns the live https URL for a (type, id).

func (Domain) Register ¶

func (Domain) Register(app *kit.App)

Register installs the client factory and every operation onto app.

type Joke ¶ added in v0.1.1

type Joke struct {
	ID        int    `kit:"id" json:"id"`
	Type      string `json:"type"`
	Setup     string `json:"setup"`
	Punchline string `json:"punchline"`
}

Joke is one joke from official-joke-api.appspot.com.

Source Files ¶

View all Source files

?	: This menu
/	: Search site
f or F	: Jump to
y or Y	: Canonical URL