🥗 The Kitchen Mess

🔗 Table of contents

1. Introduction
2. Application Overview
   1. Technologies Used
   2. Application Design
   3. API Reference
3. Getting Started
   1. Pre-requisites
   2. Environment Variables

Introduction 👋

An API app designed to return recipe information based on a specified set of include/exclude ingredients and a maximum number of calories. The app makes use of the Spoonacular Public API: https://spoonacular.com/food-api

💻 Application Overview

⚒️ Technologies Used

💡 Application Design

Class Diagram:

🔄 API Reference

Get all recipes

  GET /api/v1/recipe

Parameter	Type	Description
calories	integer	Required. The maximum number of calories a recipe should have

Get all recipes containing a set of ingredients

  GET /api/v1/recipe/${ingredients}

Parameter	Type	Description
calories	integer	Required. The maximum number of calories a recipe should have
ingredients	string	Required. The list of ingredients a recipe should include

Get all recipes containing a set of ingredients whilst excluding another set of ingredients

  GET /api/v1/recipe/${ingredients}{exingredients}

Parameter	Type	Description
calories	integer	Required. The maximum number of calories a recipe should have
ingredients	string	Required. The list of ingredients a recipe should include
exIngredients	string	Required. The list of ingredients a recipe should not include

API Endpoint User stories:

🔀 Getting Started

Pre-requisites

• C# / .NET 6
• NuGet
• Spoonacular API Key. You can sign up for a free account to obtain an API Key here:
• PostGreSQL

Environment Variables

To run this project, you will need to add the following environment variables to your .env file

SpoonacularKey - the API key provided by Spoonacular when creating an account

KitchenMessAPI - the connection string details to your PostGreSQL DB instance

//IN PROGRESS