Documentation
¶
Overview ¶
Package openbd is the library behind the openbd command line: the HTTP client, request shaping, and typed data models for the OpenBD API (https://api.openbd.jp), the Japanese book database with 1.9M ISBNs.
No API key is required. The Client paces requests, sets a real User-Agent, and retries transient failures (429 and 5xx).
Index ¶
Constants ¶
View Source
const Host = "api.openbd.jp"
Host is the site this client talks to.
Variables ¶
This section is empty.
Functions ¶
This section is empty.
Types ¶
type Book ¶
type Book struct {
ISBN string `kit:"id" json:"isbn"`
Title string `json:"title"`
Author string `json:"author"`
Publisher string `json:"publisher"`
PubDate string `json:"pubdate"`
Series string `json:"series,omitempty"`
Volume string `json:"volume,omitempty"`
Cover string `json:"cover,omitempty"`
}
Book holds the public data about a single book.
type Client ¶
type Client struct {
// contains filtered or unexported fields
}
Client talks to the OpenBD API.
type Config ¶
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 ¶
func DefaultConfig() Config
DefaultConfig returns a Config with sensible defaults.
type Coverage ¶
type Coverage struct {
Count int `json:"count"`
}
Coverage holds the count of ISBNs covered by OpenBD.
type Domain ¶
type Domain struct{}
Domain is the openbd driver.
func (Domain) Info ¶
func (Domain) Info() kit.DomainInfo
Info describes the scheme, hostnames, and binary identity.
Source Files
Click to show internal directories.
Click to hide internal directories.