summaries

Documentation

Index

• Constants
• type Summary
  • func Fetch(url string) (Summary, error)

Constants

const ErrNoSummary = domain.Error("No summary found")

ErrNoSummary is used to communicate that no summary could be obtained from Wikipedia's API

const ErrNotWiki = domain.Error("Not a Wiki page")

ErrNotWiki is used to communicate that the URL did not correspond to a Wiki page

Types

type Summary

type Summary struct {
	PageID      int    `json:"pageid"`
	Type        string `json:"type"`
	Title       string `json:"title"`
	Description string `json:"description"`
	Extract     string `json:"extract"`
}

Summary stores information retrieved from querying Wikipedia's summary API

func Fetch

func Fetch(url string) (Summary, error)

Fetch queries a Wikipedia URL page for its corresponding summary API endpoint, and returns a Summary if successful, or an error if not