mwapi

README

Merriam Webster API

Golang-based API interface for querying https://dictionaryapi.com/

Documentation

Index

• Constants
• type BaseURLs
• type Client
  • func NewClient(apiKey string, userAgent string, baseURLs *BaseURLs) Client

Constants

const Version = "0.0.2"

Version of mwapi, accessible programmatically

Types

type BaseURLs

type BaseURLs struct {
	Collegiate string
}

BaseURLs is a configuration struct for passing in custom base URLs

type Client

type Client interface {
	SetDebugf(func(string, ...interface{}) (int, error))
	SearchCollegiate(word string) ([]types.CollegiateResult, []string, error)
}

Client describes access to the Merriam-Webster dictionary at dictionaryapi.com

func NewClient

func NewClient(apiKey string, userAgent string, baseURLs *BaseURLs) Client

NewClient creates a client based on a given API key