/dogapi-go

Dog API client for Go.

Primary LanguageGoApache License 2.0Apache-2.0

Dog API

Dog API client for Go.

Download

go get github.com/thechampagne/dogapi-go

Example

func main() {
	dogs, err := dogapi.MultipleRandomImages(10)
	if err != nil {
		log.Fatal(err)
	}
	for _, dog := range dogs {
		fmt.Println(dog)
	}
}

Documentation

func BreedsList

func BreedsList() (map[string][]string, error)

BreedsList

LIST ALL BREEDS

Returns map of all the breeds as keys and sub-breeds as values if it has

func ImagesByBreed

func ImagesByBreed(breed string) ([]string, error)

ImagesByBreed

ALL IMAGES FROM A BREED COLLECTION

"breed" breed name

Returns an array of all the images from a breed, e.g. hound

func ImagesBySubBreed

func ImagesBySubBreed(breed string, subBreed string) ([]string, error)

ImagesBySubBreed

LIST ALL SUB-BREED IMAGES

"breed" breed name "sub_breed" sub_breed name

Returns an array of all the images from the sub-breed

func MultipleRandomImages

func MultipleRandomImages(imagesNumber int8) ([]string, error)

MultipleRandomImages

DISPLAY MULTIPLE RANDOM IMAGES FROM ALL DOGS COLLECTION

"images_number" number of images

"NOTE" ~ Max number returned is 50

Return multiple random dog image

func MultipleRandomImagesByBreed

func MultipleRandomImagesByBreed(breed string, imagesNumber int64) ([]string, error)

MultipleRandomImagesByBreed

MULTIPLE IMAGES FROM A BREED COLLECTION

"breed" breed name "images_number" number of images

Return multiple random dog image from a breed, e.g. hound

func MultipleRandomImagesBySubBreed

func MultipleRandomImagesBySubBreed(breed string, subBreed string, imagesNumber int64) ([]string, error)

MultipleRandomImagesBySubBreed

MULTIPLE IMAGES FROM A SUB-BREED COLLECTION

"breed" breed name "sub_breed" sub_breed name "images_number" number of images

Return multiple random dog images from a sub-breed, e.g. Afghan Hound

func RandomImage

func RandomImage() (string, error)

RandomImage

DISPLAY SINGLE RANDOM IMAGE FROM ALL DOGS COLLECTION

Returns a random dog image

func RandomImageByBreed

func RandomImageByBreed(breed string) (string, error)

RandomImageByBreed

RANDOM IMAGE FROM A BREED COLLECTION

"breed" breed name

Returns a random dog image from a breed, e.g. hound

func RandomImageBySubBreed

func RandomImageBySubBreed(breed string, subBreed string) (string, error)

RandomImageBySubBreed

SINGLE RANDOM IMAGE FROM A SUB BREED COLLECTION

"breed" breed name "sub_breed" sub_breed name

Returns a random dog image from a sub-breed, e.g. Afghan Hound

func SubBreedsList

func SubBreedsList(breed string) ([]string, error)

SubBreedsList

LIST ALL SUB-BREEDS

"breed" breed name

Returns an array of all the sub-breeds from a breed if it has sub-breeds

Generated by gomarkdoc

License

Dog API client is released under the Apache License 2.0.

 Copyright 2022 XXIV

 Licensed under the Apache License, Version 2.0 (the "License");
 you may not use this file except in compliance with the License.
 You may obtain a copy of the License at

     http://www.apache.org/licenses/LICENSE-2.0

 Unless required by applicable law or agreed to in writing, software
 distributed under the License is distributed on an "AS IS" BASIS,
 WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
 See the License for the specific language governing permissions and
 limitations under the License.