Skip to content

Latest commit

 

History

History
92 lines (53 loc) · 3.7 KB

README.md

File metadata and controls

92 lines (53 loc) · 3.7 KB

🍲 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.com/

API Documentation

OpenAPI Specification Swagger v3: https://foodish-api.com/api-docs

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

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

You may support the project here.

Endpoints

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

Example Request-

GET /api/

Example Response-

{"image":"https://foodish-api.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.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.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 mentioned below.

Support

  • Foodish is completely free to use, however, it requires some additional costs to keep the domain and service running. Help me keep it running by donating here!
  • For technical support and questions, please create a new issue.

Contributing

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

Credits

Foodish would not be possible without the work of:

License

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


Foodish API is maintained by surhud004.