apixu

README

Apixu Go

Go package for Apixu Weather API

Install

go get github.com/apixu/apixu-go

Usage

See the examples and run them with: GO111MODULE=on APIXUKEY=yourapikey go run examples/<dirname>/main.go

Error handling

For more details of an API method error, assert it to the apixu.Error type.

Full documentation of Apixu API

https://www.apixu.com/doc/

Extending the package

See the extend example.

Testing and QA tools for development

See Makefile file.

Documentation

Overview

Package apixu provides interaction with Apixu Weather service

Index

• type Apixu
  • func New(c Config) (Apixu, error)
• type Config
• type Error
  • func (ar *Error) Error() string
  • func (ar *Error) Response() response.ErrorResponse

Types

type Apixu

type Apixu interface {
	Conditions() (response.Conditions, error)
	Current(q string) (*response.CurrentWeather, error)
	Forecast(q string, days int) (*response.Forecast, error)
	Search(q string) (response.Search, error)
	History(q string, since time.Time) (*response.History, error)
}

Apixu defines methods implemented by Apixu Weather API

func New

func New(c Config) (Apixu, error)

New creates an Apixu package instance

type Config

type Config struct {
	Version string
	Format  string
	APIKey  string
}

Config is used to set up the Apixu service instance with the following:

Version: API version
Format: API response format (JSON or XML)
ApiKey: API key generated on Apixu website

type Error

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

Error adds error details based on the API error response

func (*Error) Error

func (ar *Error) Error() string

func (*Error) Response

func (ar *Error) Response() response.ErrorResponse

Response provides extra error info