surhud004 / Foodish

A Node.js/Express.js REST API to GET a random picture of food dishes.

Home Page:https://foodish-api.com

Geek Repo:Geek Repo

Github PK Tool:Github PK Tool

🍲 Foodish 🍛 Website Deploy to Production Contributions Welcome

Logo

A Node.js/Express.js REST API to GET a random picture of food dishes.

Demo

Visit https://foodish-api.herokuapp.com/

API Documentation

Base URL for all endpoints https://foodish-api.herokuapp.com/

The response time will likely be a few seconds long on the first request, because this app is running on a free Heroku dyno. Subsequent requests will behave as normal.

Endpoints

Routes Description
GET /api/ Random food dish from random category.

Example Request-

GET /api/

Example Response-

{"image":"https://foodish-api.herokuapp.com/images/burger/burger101.jpg"}

Routes Description
GET /api/images/:food Random picture from food category.

Please visit the demo website to view the list of available food categories.

Example Request-

GET /api/images/biryani

Example Response-

{"image":"https://foodish-api.herokuapp.com/images/biryani/biryani32.jpg"}

Usage

  • You are designing a restaurant website and you want to add random food pictures as placeholders.
  • You are creating a guess the food dish game.
  • You are ordering a pizza but you just want a random choice, visit https://foodish-api.herokuapp.com/images/pizza/ because that's fun! Didn't like the pizza? Just hit refresh!
  • You just like to see food pictures (visual hunger) because you eat with your eyes first.

Authors

Please note that I do not own any of the Foodish dataset images. All Foodish images and their ownership belong to their original creators.

Support

Please create a new issue for support and issues.

Contributing

Please read the CONTRIBUTING for details on adding images to the Foodish Database.

Contributors

License

This project is licensed under MIT. Please read the LICENSE for details.


Foodish API is maintained by surhud004.

About

A Node.js/Express.js REST API to GET a random picture of food dishes.

https://foodish-api.com

License:MIT License


Languages

Language:JavaScript 60.6%Language:EJS 38.0%Language:CSS 1.4%