openaire

package
v0.1.0 Latest Latest
Warning

This package is not in the latest version of its module.

Go to latest
Published: Jun 15, 2026 License: Apache-2.0 Imports: 11 Imported by: 0

Documentation

Overview

Package openaire is the library behind the openaire command line: the HTTP client, request shaping, and typed data models for the OpenAIRE public search API (https://api.openaire.eu).

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.openaire.eu"

Host is the API hostname.

Variables

This section is empty.

Functions

This section is empty.

Types

type Client

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

Client talks to the OpenAIRE API.

func NewClient

func NewClient(cfg Config) *Client

NewClient returns a Client with the given configuration.

func (*Client) Search

func (c *Client) Search(ctx context.Context, kind, keywords string, page, size int) ([]Publication, error)

Search searches publications, datasets, or software. kind must be "publications", "datasets", or "software".

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 Domain

type Domain struct{}

Domain is the openaire driver.

func (Domain) Classify

func (Domain) Classify(input string) (string, string, error)

Classify turns any accepted input into (type, id).

func (Domain) Info

func (Domain) Info() kit.DomainInfo

Info describes the scheme, hostnames, and binary identity.

func (Domain) Locate

func (Domain) Locate(t, 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 Publication

type Publication struct {
	ID        string `kit:"id" json:"id"`
	Title     string `json:"title"`
	Authors   string `json:"authors"`
	Date      string `json:"date"`
	Publisher string `json:"publisher"`
	Language  string `json:"language"`
	Access    string `json:"access"`
	Type      string `json:"type"`
	DOI       string `json:"doi,omitempty"`
}

Publication holds data for a single publication, dataset, or software record.

Jump to

Keyboard shortcuts

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