Documentation
¶
Overview ¶
Package fakestore is the library behind the fakestore command line: the HTTP client, request shaping, and the typed data models for the FakeStore API (fakestoreapi.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 site throws under load. Build your endpoint calls and JSON decoding on top of it.
Index ¶
- Constants
- type Category
- type Client
- func (c *Client) Get(ctx context.Context, url string) ([]byte, error)
- func (c *Client) GetProduct(ctx context.Context, id int) (*Product, error)
- func (c *Client) ListCategories(ctx context.Context) ([]Category, error)
- func (c *Client) ListProducts(ctx context.Context, limit int, sort, category string) ([]Product, error)
- type Domain
- type Product
- type Rating
Constants ¶
const BaseURL = "https://" + Host
BaseURL is the root every request is built from.
const DefaultUserAgent = "fakestore/dev (+https://github.com/tamnd/fakestore-cli)"
DefaultUserAgent identifies the client to fakestoreapi.com. A real, honest User-Agent is both polite and the thing most likely to keep you unblocked.
const Host = "fakestoreapi.com"
Host is the site this client talks to, and the host the URI driver in domain.go claims.
Variables ¶
This section is empty.
Functions ¶
This section is empty.
Types ¶
type Category ¶
type Category struct {
Name string `kit:"id" json:"name"`
}
Category is a product category name, wrapped so kit can address it as a resource with an id field.
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 fakestoreapi.com 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) GetProduct ¶
GetProduct fetches a single product by its integer ID.
func (*Client) ListCategories ¶
ListCategories fetches all product category names and returns them as []Category so kit can address each one by its Name id.
func (*Client) ListProducts ¶
func (c *Client) ListProducts(ctx context.Context, limit int, sort, category string) ([]Product, error)
ListProducts fetches products from the catalogue. Filtering by category, limiting the count, and sorting are all optional.
- If category is non-empty, GET /products/category/{category}
- Else if limit > 0, GET /products?limit={limit}
- Otherwise GET /products
- ?sort={sort} is appended when sort is non-empty.
type Domain ¶
type Domain struct{}
Domain is the fakestore 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 product ID, a category name, or a full fakestoreapi.com URL — into the canonical (type, id).
- All digits → ("product", id)
- Looks like a category name (letters/spaces/apostrophes) → ("category", input)
- Otherwise → ("query", 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 Product ¶
type Product struct {
ID int `kit:"id" json:"id"`
Title string `json:"title"`
Price float64 `json:"price"`
Description string `json:"description"`
Category string `json:"category"`
Image string `json:"image"`
Rating Rating `json:"rating"`
}
Product is a single item from the FakeStore catalogue.
Source Files