- To add your own images submit a pull request to https://github.com/jigsawpieces/dog-api-images
- API requests are cached from lambda https://github.com/ElliottLandsborough/dog-ceo-api-node
- php
- php-yaml
- composer
- http://vision.stanford.edu/aditya86/ImageNetDogs/images.tar
- run 'vendor/bin/phpunit' for unit tests
- Clone repo
- cd repo dir
- composer install
- Images go into /img (e.g /api/img/spaniel-irish and /api/img/spaniel-cocker or /api/img/spaniel)
- php -S localhost:8000
List all breed names including sub breeds.
List all master breed names.
List sub breeds.
Get master breed info (data is incomplete, see content folder).
Get sub breed info (data is incomplete, see content folder).
Random image from any breed.
Get 3 random images from any breed (max. 50)
Get all breed images.
Get random image from a breed (and all its sub-breeds).
Get 4 random images from a breed (and all its sub-breeds).
Get all images from a sub breed.
Get random image from a sub breed.
Get 5 random images from a sub breed.
These endpoints might change in the future...
https://dog.ceo/api/breeds/image/random/alt
https://dog.ceo/api/breeds/image/random/3/alt
https://dog.ceo/api/breed/hound/images/alt
https://dog.ceo/api/breed/hound/images/random/alt
https://dog.ceo/api/breed/hound/images/random/3/alt
https://dog.ceo/api/breed/hound/afghan/images/alt
https://dog.ceo/api/breed/hound/afghan/images/random/alt
Add 'Content-Type' request header containing 'application/xml'. Alternatively, add '/xml' to any endpoint:
https://dog.ceo/api/breeds/image/random/3/alt/xml
cp .env.example .env
CREATE DATABASE `dogstats`;
CREATE TABLE `dogstats`.`daily` ( `id` INT NOT NULL AUTO_INCREMENT , `route` VARCHAR(100) CHARACTER SET utf8 COLLATE utf8_unicode_ci NULL DEFAULT NULL , `date` DATE NOT NULL , `hits` INT NOT NULL DEFAULT '0' , PRIMARY KEY (`id`), INDEX (`route`), INDEX (`date`)) ENGINE = InnoDB;
CREATE TABLE `visits` (
`id` int NOT NULL AUTO_INCREMENT PRIMARY KEY,
`ip` varchar(39) COLLATE 'utf8_unicode_ci' NULL,
`date` datetime NOT NULL,
`country` varchar(2) COLLATE 'utf8_unicode_ci' NULL,
`endpoint` text COLLATE 'utf8_unicode_ci' NULL,
`user-agent` varchar(255) COLLATE 'utf8_unicode_ci' NULL,
`referrer` text COLLATE 'utf8_unicode_ci' NULL
);
ALTER TABLE `visits` ADD INDEX(`country`);
ALTER TABLE `daily` ADD INDEX( `route`, `date`);
ALTER TABLE `visits` ADD INDEX(`ip`);
Put this at the bottom of index.php
use models\Statistic;
// keep some stats after the response is sent
// only do stats if db exists in .env
if (isset($request) && getenv('DOG_CEO_DB_HOST')) {
//$routeName = $request->get('_route');
$uri = $request->getRequestUri();
// only save stats if successful request
if ($uri !== '/stats' && $response->getStatusCode() == '200') {
$stats = new Statistic();
$stats->save($uri);
}
}
Copyright (c) 2018 Dog CEO
Permission is hereby granted, free of charge, to any person obtaining a copy of this software and associated documentation files (the "Software"), to deal in the Software without restriction, including without limitation the rights to use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies of the Software, and to permit persons to whom the Software is furnished to do so, subject to the following conditions:
The above copyright notice and this permission notice shall be included in all copies or substantial portions of the Software.
THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.