Petfinder API
This Module is created to simplify working with the PetFinder API That allows you to look for pets needing adoption. Most Calls Are public and do not require a secret.
Installation
NPM
npm install pet-finder-api --save
--save
adds pet-finder-api to your package.json
file
package.json
:
Package Manager
Example
// Import modulevar petfinder = 'api_key''api_secret'; // Get list of breedspetfinder;
Methods
Pets
// animal = barnyard, bird, cat, dog, horse, pig, reptile, smallfurry
Shelters
// breed get from getBreedList
Contributing
- Fork it
- Create your feature branch (
git checkout -b my-new-feature
) - Commit your changes (
git commit -am 'Added some awesome feature'
) - Push to the remote branch (
git push origin my-new-feature
) - Create a pull request
Running Tests
cp .env.example .env
npm test
to record api calls
REPLAY=record npm test
to debug recorded api calls
DEBUG=replay npm test