Documentation
¶
Overview ¶
Package fakerapi is the library behind the fakerapi command line: the HTTP client, request shaping, and the typed data models for fakerapi.
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. Build your endpoint calls and JSON decoding on top of it.
Index ¶
Constants ¶
const BaseURL = "https://" + Host
BaseURL is the root every request is built from.
const DefaultUserAgent = "fakerapi/dev (+https://github.com/tamnd/fakerapi-cli)"
DefaultUserAgent identifies the client to fakerapi. A real, honest User-Agent is both polite and the thing most likely to keep you unblocked.
const Host = "fakerapi.com"
Host is the site this client talks to, and the host the URI driver in domain.go claims. The scaffold points it at fakerapi.com; change it once you know the real endpoints you want to read.
Variables ¶
This section is empty.
Functions ¶
This section is empty.
Types ¶
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 fakerapi over HTTP.
func NewClient ¶
func NewClient() *Client
NewClient returns a Client with sensible defaults: a 30s timeout, a 200ms 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) GetPage ¶
GetPage fetches one page by its path (for example "wiki/Go") and returns it as a record. The scaffold keeps a plain-text preview of the response as the body; replace the parsing with the real fields once you know the endpoint's shape.
type Domain ¶
type Domain struct{}
Domain is the fakerapi 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 — a bare path or a full fakerapi.com URL — into the canonical (type, id), so `ant resolve` and `ant url` touch no network.
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 Page ¶
type Page struct {
ID string `json:"id" kit:"id"`
URL string `json:"url"`
Title string `json:"title,omitempty"`
Body string `json:"body,omitempty" kit:"body"`
}
Page is the scaffold's one example record: a single page, addressed by the path that names it on fakerapi.com. It is a stand-in for the typed records you will model from the real fakerapi endpoints. The kit struct tags make it addressable as a resource URI (see domain.go): ID is the URI id, and Body is the long text `fakerapi cat` and the Markdown export print.
Source Files