spoonacular_api v1.0.0

spoonacular_api

SpoonacularApi - JavaScript client for spoonacular_api The spoonacular Nutrition, Recipe, and Food API allows you to access over 380,000 recipes, thousands of ingredients, 80,000 food products, and 100,000 menu items. Our food ontology and semantic recipe search engine makes it possible to search for recipes using natural language queries, such as \"gluten free brownies without sugar\" or \"low fat vegan cupcakes.\" You can automatically calculate the nutritional information for any recipe, analyze recipe costs, visualize ingredient lists, find recipes for what's in your fridge, find recipes based on special diets, nutritional requirements, or favorite ingredients, classify recipes into types and cuisines, convert ingredient amounts, or even compute an entire meal plan. With our powerful API, you can create many kinds of food and especially nutrition apps. Special diets/dietary requirements currently available include: vegan, vegetarian, pescetarian, gluten free, grain free, dairy free, high protein, whole 30, low sodium, low carb, Paleo, ketogenic, FODMAP, and Primal. This SDK is automatically generated by the OpenAPI Generator project:

• API version: 1.0
• Package version: 1.0
• Build package: org.openapitools.codegen.languages.JavascriptClientCodegen For more information, please visit https://spoonacular.com/contact

Installation

For Node.js

npm

To publish the library as a npm, please follow the procedure in "Publishing npm packages".

Then install it via:

npm install spoonacular_api --save

Finaly, you need to build the module:

npm run build

Local development

To use the library locally without publishing to a remote npm registry, first install the dependencies by changing into the directory containing package.json (and this README). Let's call this JAVASCRIPT_CLIENT_DIR. Then run:

npm install

Next, link it globally in npm with the following, also from JAVASCRIPT_CLIENT_DIR:

npm link

To use the link you just defined in your project, switch to the directory you want to use your spoonacular_api from, and run:

npm link /path/to/<JAVASCRIPT_CLIENT_DIR>

Finaly, you need to build the module:

npm run build

git

If the library is hosted at a git repository, e.g.https://github.com/GIT_USER_ID/GIT_REPO_ID then install it via:

    npm install GIT_USER_ID/GIT_REPO_ID --save

For browser

The library also works in the browser environment via npm and browserify. After following the above steps with Node.js and installing browserify with npm install -g browserify, perform the following (assuming main.js is your entry file):

browserify main.js > bundle.js

Then include bundle.js in the HTML pages.

Webpack Configuration

Using Webpack you may encounter the following error: "Module not found: Error: Cannot resolve module", most certainly you should disable AMD loader. Add/merge the following section to your webpack config:

module: {
  rules: [
    {
      parser: {
        amd: false
      }
    }
  ]
}

Getting Started

Please follow the installation instruction and execute the following JS code:

var SpoonacularApi = require('spoonacular_api');


var api = new SpoonacularApi.DefaultApi()
var q = salmon with fusilli and no nuts; // {String} The recipe search query.
var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully. Returned data: ' + data);
  }
};
api.analyzeARecipeSearchQuery(q, callback);

Documentation for API Endpoints

All URIs are relative to https://api.spoonacular.com

Documentation for Models

• SpoonacularApi.InlineObject
• SpoonacularApi.InlineObject1
• SpoonacularApi.InlineObject2
• SpoonacularApi.InlineObject3
• SpoonacularApi.InlineObject4
• SpoonacularApi.InlineObject5
• SpoonacularApi.InlineObject6
• SpoonacularApi.InlineObject7
• SpoonacularApi.InlineObject8
• SpoonacularApi.InlineObject9

Documentation for Authorization

apiKeyScheme

• Type: API key
• API key parameter name: api_key
• Location: URL query string