cat-api-boilerplate

A starting point for creating your very own cat API.

Stars
7
Committers
2

Cat API Boilerplate Boilerplate

Cat API Boilerplate Boilerplate is the fastest way to start developing a Cat API project. Leverage years of experience with a Cat API in seconds flat with Cat API Boilerplate.

How to Contribute

Do you have any good starting images of cats? Do you have an affinity for cute fluffy asshole animals? Please fork and contribute in any way you can!

Dependencies

You will need to install Node.js before using this Boilerplate.

Getting started

To get started, simply clone this repo and run the following command

npm install

Once you have installed the dependencies, simply run the API server

node api

Once the API server is running, you can access the REST API:

  • /all Will return all Cat images

  • /random Will return a random Cat image

  • /img/:src Will return the actual image so you can embed in an <img/> tag.