Documentation
¶
Overview ¶
Package stapi is the library behind the stapi command line: the HTTP client, request shaping, and the typed data models for the Star Trek API (stapi.co).
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 site throws under load.
Index ¶
- Constants
- type Character
- type Client
- func (c *Client) Get(ctx context.Context, url string) ([]byte, error)
- func (c *Client) GetCharacter(ctx context.Context, uid string) (*Character, error)
- func (c *Client) GetEpisode(ctx context.Context, uid string) (*Episode, error)
- func (c *Client) ListCharacters(ctx context.Context, limit int) ([]Character, error)
- func (c *Client) ListEpisodes(ctx context.Context, limit int) ([]Episode, error)
- func (c *Client) ListSeries(ctx context.Context) ([]Series, error)
- type Domain
- type Episode
- type Series
Constants ¶
const BaseURL = "https://" + Host
BaseURL is the root every request is built from.
const DefaultUserAgent = "stapi-cli/dev (+https://github.com/tamnd/stapi-cli)"
DefaultUserAgent identifies the client to stapi.co.
const Host = "stapi.co"
Host is the site this client talks to.
Variables ¶
This section is empty.
Functions ¶
This section is empty.
Types ¶
type Character ¶
type Character struct {
UID string `kit:"id" json:"uid"`
Name string `json:"name"`
Gender string `json:"gender"`
Deceased bool `json:"deceased"`
Hologram bool `json:"hologram"`
FictionalCharacter bool `json:"fictionalCharacter"`
Mirror bool `json:"mirror"`
}
Character is a Star Trek character.
type Client ¶
type Client struct {
HTTP *http.Client
UserAgent 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 stapi.co over HTTP.
func NewClient ¶
func NewClient() *Client
NewClient returns a Client with sensible defaults: a 30s timeout, a 300ms minimum gap between requests, and five retries on transient errors.
func (*Client) Get ¶
Get fetches url and returns the response body. It paces and retries according to the client's settings. The caller owns nothing extra; the body is read fully and closed here.
func (*Client) GetCharacter ¶
GetCharacter fetches a single character by UID.
func (*Client) GetEpisode ¶
GetEpisode fetches a single episode by UID.
func (*Client) ListCharacters ¶
ListCharacters fetches a page of characters from the search endpoint.
func (*Client) ListEpisodes ¶
ListEpisodes fetches a page of episodes from the search endpoint.
type Domain ¶
type Domain struct{}
Domain is the stapi driver. It carries no state; the per-run client is built by the factory Register hands kit.
func (Domain) Classify ¶
Classify turns any accepted input into the canonical (type, id). UID pattern detection: "CH" prefix -> character, "EP" -> episode, "SE" -> series.
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 Episode ¶
type Episode struct {
UID string `kit:"id" json:"uid"`
Title string `json:"title"`
Series string `json:"series"` // extracted from series.title
SeasonNumber int `json:"seasonNumber"`
EpisodeNumber int `json:"episodeNumber"`
FeatureLength bool `json:"featureLength"`
}
Episode is a Star Trek episode.
Source Files